Skip to main content

Standalone Variable Static Typing

Project description

Standalone Variable Static Typing (svst)

Full-on Python Static Typing

Python Version Stable Version Downloads Build Status Documentation Status Checked with mypy Code style: black Linting: ruff

Standalone Variable Static Type Checker using Abstract Syntax Trees

Why?

Python is an amazing programming language; my favorite one for a lot of reasons. With the broad functionality, ease of use, development speed, and friendly community; I could be here all day saying good things about it.

One of the major selling points the dynamic typing, at least initially.

When you start scaling Python and using it on huge projects dealing with a lot of different entities and flows you can make a mistake and find the pitfall of not knowing why your variable is not behaving as you wish it was; between other issues (if you try to statically type an existing codebase with mypy you'll find how bad your code is in terms of type consistency; at least that happened to me).

After fixing a huge mess I wanted to go a step further and not only enforce the typing of functions/classes input and output but to type my standalone variables as well until I found that mypy doesn't check that because his goal is to find the balance between dynamic and static typing; I wanted to go full-on static.

At first, I created a simple file to do this, but soon I found that I needed a proper implementation of this to spread to all my projects and possibly help the community.

I'd like to extend immense gratitude to @alphasensei for pioneering the research and developing the initial proof of concept for this library.

This is an attempt of bringing full-on static typing to Python and, with it, much more robust codebases.

Quick start

Svst can be installed using pip:

python3 -m pip install -U svst

You can type-check the standalone variables of a program like this:

svst PROGRAM

You can type-check a program including the mypy functionality like this as well:

svst --mypy PROGRAM

Integrations

  • Vim
  • PyCharm
  • VS Code
  • pre-commit

Documentation

Contributing

Project details


Download files

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

Source Distribution

svst-0.1.2.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

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

svst-0.1.2-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file svst-0.1.2.tar.gz.

File metadata

  • Download URL: svst-0.1.2.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.17

File hashes

Hashes for svst-0.1.2.tar.gz
Algorithm Hash digest
SHA256 ae0cded44211484a7d3dc24cf1f2dc782e485020386dfa61b8311c310e1c81f4
MD5 dfaf7a6d50b5a098635c1c5788170b7c
BLAKE2b-256 abbe0ef950bb05f48cf26e2a17ee5273b884d59b39b88f86d8aeb44fc3367d61

See more details on using hashes here.

File details

Details for the file svst-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: svst-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 12.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.17

File hashes

Hashes for svst-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ffaff3d2fbef794b17081656faaa836db4f1e2a092566067acd13c305fe8c42a
MD5 4c89b42eab4f36adc678be34d8bc2853
BLAKE2b-256 db8737a911de4dc0d791279c7aed826da0c50c8ac4aa6452c57c629e6a907c09

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