Skip to main content

paradigm

In what follows python is an alias for python3.10 or any later version (python3.11 and so on).

Installation

Install the latest pip & setuptools packages versions

python -m pip install --upgrade pip setuptools

User

Download and install the latest stable version from PyPI repository

python -m pip install --upgrade paradigm

Developer

Download the latest version from GitHub repository

git clone https://github.com/lycantropos/paradigm.git
cd paradigm

Install dependencies

python -m pip install -r requirements.txt

Install

python setup.py install

Usage

With setup

>>> import typing
>>> from paradigm.base import (
...     OptionalParameter,
...     ParameterKind,
...     PlainSignature,
...     RequiredParameter,
...     signature_from_callable,
... )
>>> from typing_extensions import Self
>>> class UpperOut:
...     def __init__(self, outfile: typing.IO[typing.AnyStr]) -> None:
...         self._outfile = outfile
...     def write(self, s: typing.AnyStr) -> None:
...         self._outfile.write(s.upper())
...     def __getattr__(self, name: str) -> typing.Any:
...         return getattr(self._outfile, name)
...
>>> def func(
...     foo: int, /, bar: float, *, baz: bool = False, **kwargs: str
... ) -> None:
...     pass
...

we can obtain a signature of

  • user-defined functions
    >>> signature_from_callable(func) == PlainSignature(
    ...     RequiredParameter(
    ...         annotation=int,
    ...         kind=ParameterKind.POSITIONAL_ONLY,
    ...         name='foo',
    ...     ),
    ...     RequiredParameter(
    ...         annotation=float,
    ...         kind=ParameterKind.POSITIONAL_OR_KEYWORD,
    ...         name='bar',
    ...     ),
    ...     OptionalParameter(
    ...         annotation=bool,
    ...         default=False,
    ...         kind=ParameterKind.KEYWORD_ONLY,
    ...         name='baz',
    ...     ),
    ...     OptionalParameter(
    ...         annotation=str,
    ...         kind=ParameterKind.VARIADIC_KEYWORD,
    ...         name='kwargs',
    ...     ),
    ...     returns=None,
    ... )
    True
    
  • user-defined classes
    >>> signature_from_callable(UpperOut) == PlainSignature(
    ...     RequiredParameter(
    ...         annotation=typing.IO[typing.AnyStr],
    ...         kind=ParameterKind.POSITIONAL_OR_KEYWORD,
    ...         name='outfile',
    ...     ),
    ...     returns=Self,
    ... )
    True
    
  • user-defined classes methods
    >>> signature_from_callable(UpperOut.write) == PlainSignature(
    ...     RequiredParameter(
    ...         annotation=typing.Any,
    ...         kind=ParameterKind.POSITIONAL_OR_KEYWORD,
    ...         name='self',
    ...     ),
    ...     RequiredParameter(
    ...         annotation=typing.AnyStr,
    ...         kind=ParameterKind.POSITIONAL_OR_KEYWORD,
    ...         name='s',
    ...     ),
    ...     returns=None,
    ... )
    True
    
  • built-in functions
    >>> signature_from_callable(any) == PlainSignature(
    ...     RequiredParameter(
    ...         annotation=typing.Iterable[object],
    ...         kind=ParameterKind.POSITIONAL_ONLY,
    ...         name='iterable',
    ...     ),
    ...     returns=bool,
    ... )
    True
    
  • built-in classes
    >>> signature_from_callable(bool) == PlainSignature(
    ...     OptionalParameter(
    ...         annotation=object,
    ...         kind=ParameterKind.POSITIONAL_ONLY,
    ...         name='o',
    ...     ),
    ...     returns=Self,
    ... )
    True
    
  • built-in classes methods
    >>> signature_from_callable(float.hex) == PlainSignature(
    ...     RequiredParameter(
    ...         annotation=Self,
    ...         kind=ParameterKind.POSITIONAL_ONLY,
    ...         name='self',
    ...     ),
    ...     returns=str,
    ... )
    True
    

Development

Bumping version

Preparation

Install bump-my-version.

Pre-release

Choose which version number category to bump following semver specification.

Test bumping version

bump-my-version bump --dry-run --verbose $CATEGORY

where $CATEGORY is the target version number category name, possible values are patch/minor/major.

Bump version

bump-my-version bump --verbose $CATEGORY

This will set version to major.minor.patch-alpha.

Release

Test bumping version

bump-my-version bump --dry-run --verbose release

Bump version

bump-my-version bump --verbose release

This will set version to major.minor.patch.

Running tests

Install dependencies

python -m pip install -r requirements-tests.txt

Plain

pytest

Inside Docker container:

  • with CPython
    docker-compose --file docker-compose.cpython.yml up
    
  • with PyPy
    docker-compose --file docker-compose.pypy.yml up
    

Bash script (e.g. can be used in Git hooks):

  • with CPython

    ./run-tests.sh
    

    or

    ./run-tests.sh cpython
    
  • with PyPy

    ./run-tests.sh pypy
    

PowerShell script (e.g. can be used in Git hooks):

  • with CPython
    .\run-tests.ps1
    
    or
    .\run-tests.ps1 cpython
    
  • with PyPy
    .\run-tests.ps1 pypy
    

Metadata

Release files for paradigm 4.4.1

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

Source distribution (sdist)

Source distribution for paradigm 4.4.1
File Size Uploaded Provenance Actions
paradigm-4.4.1.tar.gz 37.3 kB Without provenance Details for paradigm-4.4.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for paradigm 4.4.1
File Interpreter ABI Platform Actions
paradigm-4.4.1-py3-none-any.whl Python 3 none any Details for paradigm-4.4.1-py3-none-any.whl

Total release size: 79.1 kB

Release files / paradigm-4.4.1.tar.gz

Download URL paradigm-4.4.1.tar.gz
Size 37.3 kB
Tags Source
SHA-256 checksum
How to use checksums
7518747bd70ed09881a569474b468a3f1434944bc2a8c8936d3c1c43722335a8
BLAKE2b-256 checksum
How to use checksums
6bc7d1e26ddc204c7fe59d833a4deda25d14a504a802d500d2d90db9d2953570
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / paradigm-4.4.1-py3-none-any.whl

Download URL paradigm-4.4.1-py3-none-any.whl
Size 41.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9169cf24d96f2cfc3278aa58357158d99da4573b05f7d39434da4977b3ece959
BLAKE2b-256 checksum
How to use checksums
1c264144ce7c0ef8da05724dfda3566894f9bad7675817fd1d7453964caf2f2e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Security for paradigm 4.4.1

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

4.4.1 This release

2 release files 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