Skip to main content

coverage report

decorit

The documentation including examples can be found here.

This is a package with handy ready-to-use decorators for daily scripting and maintaining packages. Decorator requests are highly appreciated, simply open an issue.

If you want to learn how to write your own decorators I recommand to head over to realpython and check out this article. In case you are looking for an wrapper to easily write decorators for your own, you might checkout pydecor.

This project is in an alpha stage, hence it is neither stable nor ready for production.

CAUTION: Starting from version 1.0.0 API-breaking changes will be made only in major releases. Until then, it can be changed in every minor release (see changelog).

Features

Existing decorators:

  • copy_doc: copy docstring of existing function
  • copy_doc_params: copy parameters of docstring of existing function
  • deprecated: print deprecated warning on call
  • alias: give multiple names to function, e.g. short and long
  • logging: logging call of functions
  • time: timeing execution of function
  • run_once: run function only once at first call

Usage

Installation

python3 -m pip install decorit

Usage

import decorit

# start decorating your functions

Building Documentation:

The doc is based on pdoc and can be created by simply running bash create_doc.sh from the docs folder. For dependencies see in the CI action.

Similar Projects

Credits:

In alphabetical order:

Metadata

Release files for decorit 0.2.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 decorit 0.2.0
File Size Uploaded Provenance Actions
decorit-0.2.0.tar.gz 7.7 kB Without provenance Details for decorit-0.2.0.tar.gz

Built distribution (wheel)

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

Total release size: 14.0 kB

Release files / decorit-0.2.0.tar.gz

Download URL decorit-0.2.0.tar.gz
Size 7.7 kB
Tags Source
SHA-256 checksum
How to use checksums
67280fdfb47f9d503c62bdfcc4b22903c43f6bcd2e2f4cd22dd7ee4f2f23e52e
BLAKE2b-256 checksum
How to use checksums
9a31aa65c4eaaaa50df4aaeef93da8827f58a31e5be1eaeab21a7f4a45803a15
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.9.12

Release files / decorit-0.2.0-py3-none-any.whl

Download URL decorit-0.2.0-py3-none-any.whl
Size 6.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b1acdf52d9713199e357166d3f8a50317cbea78559a2dbbc6399ce9385a0bc78
BLAKE2b-256 checksum
How to use checksums
b47efde4910d15ba7c05feb25d293434db2b61ee5cea5f50827cdf25ddf96b37
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.9.12

Security for decorit 0.2.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.

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