Skip to main content

Python Package

PyPI version fury.io

PyPI pyversions

GitHub license

GitHub tag

Json Mix

A Python library for validate json. In this 0.1.0 version of jsonmix, it allows you to validate the json that you this awaiting.

Installation

The latest stable version is available on PyPI. Either add jsonmix to your requirements.txt file or install with pip:

pip install jsonmix

Description

This project is to help other types of projects that need a json validation, and with this lib, you can validate fields, validate the types of fields or if it is necessary to validate both together.

Steps

Step 0:

In this lib we use the decorator, so for you to use it would be through a function or class, so it would start by importing the lib:

import jsonmix

To be more specific and save space in memory, it could also import this way:

from jsonmix.validate import validate_json

examples of how to use:

  • operation receiving fields

      def hello():
    
          receive_json = {
    
              'uid': 1,
    
              'Name': 'Json Mix',
    
              'Version': '0.1.0',
    
              'message': 'A library for validate in python'
    
          }
    
          model_json = {
    
              'uid': int,
    
              'Name': str,
    
              'Version': str,
    
              'message': str
    
          }
    
          response = {
    
              "code": "JMERR-001",
    
              "data": {
    
                  "error": "inconsistency on JSON structure",
    
                  "message": "Missing required JSON field"
    
              },
    
              "date": str(datetime.now().timestamp()),
    
          }
    
          return validate_json(receive=receive_json, model=model_json, response_field=response, operation='fields')
    
  • operation receiving fields types

          def hello():
    
              receive_json = {
    
                  'uid': 1,
    
                  'Name': 'Json Mix',
    
                  'Version': '0.1.0',
    
                  'message': 'A library for validate in python'
    
              }
    
              model_json = {
    
                  'uid': int,
    
                  'Name': str,
    
                  'Version': str,
    
                  'message': str
    
              }
    
              response = {
    
                  "code": "JMERR-002",
    
                  "data": {
    
                      "error": "inconsistency on JSON structure",
    
                      "message": "JSON field type is incorrect"
    
                  },
    
                  "date": str(datetime.now().timestamp())
    
              }
    
              return validate_json(receive=receive_json, model=model_json, response_field=response, operation='types')
    
  • operation receiving decorator

          receive_json = {
    
                  'uid': 1,
    
                  'Name': 'Json Mix',
    
                  'Version': '0.1.0',
    
                  'message': 'A library for validate in python'
    
              }
    
          model_json = {
    
              'uid': int,
    
              'Name': str,
    
              'Version': str,
    
              'message': str
    
          }
    
          response_fields = {
    
              "code": "JMERR-001",
    
              "data": {
    
                  "error": "inconsistency on JSON structure",
    
                  "message": "Missing required JSON field"
    
              },
    
              "date": str(datetime.now().timestamp()),
    
          }
    
          response_types = {
    
              "code": "JMERR-002",
    
              "data": {
    
                  "error": "inconsistency on JSON structure",
    
                  "message": "JSON field type is incorrect"
    
              },
    
              "date": str(datetime.now().timestamp())
    
          }
    
    
    
          @validate_json(receive=receive_json, model=model_json, response_field=response_fields, response_field_types=response_types, operation='decorator')
    
          def hello():
    
              return 'Hello Word'
    
    • operation receiving default

          def hello():
      
              receive_json = {
      
                      'uid': 1,
      
                      'Name': 'Json Mix',
      
                      'Version': '0.1.0',
      
                      'message': 'A library for validate in python'
      
                  }
      
              model_json = {
      
                  'uid': int,
      
                  'Name': str,
      
                  'Version': str,
      
                  'message': str
      
              }
      
              response_fields = {
      
                  "code": "JMERR-001",
      
                  "data": {
      
                      "error": "inconsistency on JSON structure",
      
                      "message": "Missing required JSON field"
      
                  },
      
                  "date": str(datetime.now().timestamp()),
      
              }
      
              response_types = {
      
                  "code": "JMERR-002",
      
                  "data": {
      
                      "error": "inconsistency on JSON structure",
      
                      "message": "JSON field type is incorrect"
      
                  },
      
                  "date": str(datetime.now().timestamp())
      
              }
      
              return validate_json(receive=receive_json, model=model_json, response_field=response_fields, response_field_types=response_types, operation='decorator')
      

Notice that I pass 4 parameters that are them:

  1. receive_json: The json you receive from an API or elsewhere.

  2. model_json: The model json you created to be the basis of your validations

  3. response_json_field: Your error response if the error is in the json keys

  4. response_json_field_type: Your error response if the error is in the json types

Step 2:

We have a test example of each of the parameter passages

  • receive_json

    example_json_receive = {

        'uid': 1,

        'Name': 'Json Mix',

        'Version': '0.1.0',

        'message': 'A library for validate in python'

    }

  • model_json

    example_json_model = {

        'uid': int,

        'Name': str,

        'Version': str,

        'message': str

    }

  • response_json_field

  example_json_custom_error_response_field = {

        "code": "JMERR-001",

        "data": {

            "error": "inconsistency on JSON structure",

            "message": "Missing required JSON field"

        },

        "date": str(datetime.now().timestamp())

  }

  • response_json_field_type

    example_json_custom_error_response_field_type = {

        "code": "JMERR-002",

        "data": {

            "error": "inconsistency on JSON structure",

            "message": "JSON field type is incorrect"

        },

        "date": str(datetime.now().timestamp())

    }

Now that I have shown you the examples of possible json of each parameter that validate_json receives and I have shown an example of use.

Step 3:

Let's suppose that you set up your json model, to be able to validate with the json that is coming, and this was your model json:


    example_json_model = {

        'uid': int,

        'Name': str,

        'Version': str,

        'message': str

    }

With that there are some malicious people who want to invade or damage your website, app or some software of your own in some way and start editing your receiving json like changing the names of the keys, changing the types or even adding a new key to your json , see these examples of possible json that a malicious person could pass on to you.


    example_json_model = {

        'uid': int,

        'Name': str,

        'Version': str,

        'message': str

    }


    example_json_model = {

        'uid': int,

        'Name': str,

        'Version': str,

        'message': str

    }


    example_json_model = {

        'uid': int,

        'Name': str,

        'Version': str,

        'message': str

    }

Soon you realize that in the first example you receive a json with the wrong type, in this case your key 'uid' you defined as int and is receiving it as a string, in the second example we can see that an extra key was assigned in your json that would be the 'add_field' that is not in your json model, in the third example you receive a json with the invalid key, in which case your key for the json model is 'Name' and what you received is 'Na'. So these are the possible invalid json that can be received.

Metadata

Release files for jsonmix 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jsonmix 0.1.0
File Size Uploaded Provenance Actions
jsonmix-0.1.0.tar.gz 6.5 kB Without provenance Details for jsonmix-0.1.0.tar.gz

Release files / jsonmix-0.1.0.tar.gz

Download URL jsonmix-0.1.0.tar.gz
Size 6.5 kB
Tags Source
SHA-256 checksum
How to use checksums
4365e38ab410fd23c32991f4b9a5d16cc0138c0c29f155e470323944ae9c15e7
BLAKE2b-256 checksum
How to use checksums
5ed3402f0856f14ea1be0e1f4884549e9bc42639eb777c98750863ec7ce2eed6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

Security for jsonmix 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page