Skip to main content

Decorators, warnings, and exceptions for explicitly marking the development status of Python objects

Project description

devstatusdecos

Decorators, warnings, and exceptions for explicitly marking the development status of Python objects.

CodeQL Ko-Fi

This module provides structured, runtime-enforced annotations for things like deprecation, experimental APIs, insecure code paths, and unfinished implementations.

Documentation

Features

  • Imports (and requires access to) the deprecated decorator from either typing_extensions or warnings. typing_extensions is requires for python < 3.13.3.
  • pending_deprecation, which raises the builtin PendingDeprecationWarning with optional the option of automatic escalation to deprecated status based on python version.
  • experimental, analogous to deprecated, raises a ExperimentalWarning warning when called.
  • todo, analogous to deprecated, raises a ExperimentalWarning warning when called, optionally raising a TodoError in a wrapped callable.
  • insecure, which always raises a InsecureError or FatallyInsecureError, optionally exiting.

Installation

pip install devstatusdecos

Example

from devstatusdecos import experimental, todo, insecure

@experimental("API may change")
def new_feature():
   ...

@todo("Implement edge case handling")
class Incomplete():
   def __init__(self):
      ...

@insecure("Uses unsafe cryptography", fatal=True)
def bad_idea():
   ...

Security Policy

While the python source code will be actively maintained, any binary files (if at all provided) are in no way supported. These are provided as a courtesy and are not intended to be the main usage of this software. Please keep this in mind when choosing how you wish to use this software.

Supported Versions

Version Supported
0.0.0.0 <

Reporting a Vulnerability

Please report any issues to the email 107761433+MarkusHammer{THEN THE @ SYMBOL HERE}users.noreply.github.com

Copyright © 2026 Markus Hammer

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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

devstatusdecos-1.0.0.0.tar.gz (8.2 kB view details)

Uploaded Source

Built Distribution

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

devstatusdecos-1.0.0.0-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file devstatusdecos-1.0.0.0.tar.gz.

File metadata

  • Download URL: devstatusdecos-1.0.0.0.tar.gz
  • Upload date:
  • Size: 8.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for devstatusdecos-1.0.0.0.tar.gz
Algorithm Hash digest
SHA256 59dae4c33a99290e81567b71a04fdd305e6c8f2627f71f91289a1f5c9db56400
MD5 ecc06f7d1f980ecc5eb90b9729d33c83
BLAKE2b-256 948a48697103dde40b9653cc515f49c493b4f99e4da7da96f8e45d8958719541

See more details on using hashes here.

File details

Details for the file devstatusdecos-1.0.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for devstatusdecos-1.0.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9ac85a95b88b5fef97c01dddbb1256d978fb0505f5304d31a4195a27cff36939
MD5 89172e74877fdd6c5340be40011670ec
BLAKE2b-256 af4483f1b53deeb014f4e64566b2a3391dca464ac52cd4d522c6f90a0fb3da51

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