Skip to main content

Bynd is a simple way of achieving static typing in Python.

Project description

                            ██████╗ ██╗   ██╗███╗   ██╗██████╗ 
                            ██╔══██╗╚██╗ ██╔╝████╗  ██║██╔══██╗
                            ██████╔╝ ╚████╔╝ ██╔██╗ ██║██║  ██║
                            ██╔══██╗  ╚██╔╝  ██║╚██╗██║██║  ██║
                            ██████╔╝   ██║   ██║ ╚████║██████╔╝
                            ╚═════╝    ╚═╝   ╚═╝  ╚═══╝╚═════╝

A module which allows binding data to one or more types. Bynd's intended use case is to be assigned to a variable. The benefits of using Bynd are static type checking at runtime and being able to access the bound data and its types. A variable, in this case, can still be used the same way with one simple change; using the dot operator to access the data.

Bynd: Basic Usage

# filename: Bynd_test.py
from Bynd.bynd import Bynd

# Instantiates a Bynd object and binds the data "some string" to the type 'str'
my_variable = Bynd("some string")[str] 

# The above code will raise a 'ByndError' if the data is not of type 'str'

# To access the data, we can use the dot '.' operator.
print("my_variable.data: ", my_variable.data)

# The type(s) can also be accessed the same way.
print("my_variable.types: ", my_variable.types)

# Output:
#    my_variable.data: "some string"
#    my_varaible.types: {<class 'str'>}

Recursive Type Checking: A Second Layer of Security

# filename: Bynd_test_2.py
from Bynd.bynd import Bynd

# Bynd can perform recursive type checking for collection types using the 'inner' method.
my_list = Bynd([1,2,3,[4,5,6], {'key': {'data': 21}}])[list]

# The 'inner' method allows us to specify the inner types for all
# possible collections. These types will be used for all collections
# including nested ones, meaning the types need to be known in advance.
# The 'inner' method returns the original 'Bynd' instance so it doesn't
# have to be used separately.
#     So, we can do this:
#     my_list = Bynd([1,2,3,[4,5,6], {'key': {'data': 21}}])[list].inner(str, int, list, dict)
#
#     Instead of this:
#     my_list.inner(str, int, list, dict)

# The above code will raise a 'ByndError' if any of the collection
# items are not one of the types 'str', 'int', 'list', or 'dict'

# Finally, if there aren't any errors, we can access and print the data and the types.
print("my_list.data: ", my_list.data)
print("my_list.types: ", my_list.types)

# Output:
#    my_list.data: [1,2,3[4,5,6], {'key': {'data': 21}}]
#    my_list.types: {<class 'dict'>, <class 'int'>, <class 'list'>, <class 'str'>}

# NOTE: recursive type checking only occurs when the 'inner' method is used and if
#   it encounters a collection type. Recursive type checking happens automatically
#   within the 'inner' method itself. It will do nothing if a collection type isn't
#   encountered. 

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bynd-1.4-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

Details for the file bynd-1.4-py3-none-any.whl.

File metadata

  • Download URL: bynd-1.4-py3-none-any.whl
  • Upload date:
  • Size: 4.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.14

File hashes

Hashes for bynd-1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 240d4a5e0e80aa9ea796c7e79976e40858ba85ea74b6c0feb79499a6d281aecd
MD5 15e100fd2c991044a9bb94edce7e1519
BLAKE2b-256 d9823580ba3941f27842a80940163d246c0c3d2a8d581f96eda457da663a624f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page