Skip to main content

A package for easing return of multiple values

Project description

Warg

Warg

Build Status Documentation Code style: black Coverage Status codebeat badge Codeship Status for pything/warg codecov
Workflows
Publish Python 🐍 distributions 📦 to PyPI and TestPyPI
On Push Any Documentation Check
CodeQL

Devour everything :wolf: Prey upon

python


Old-Norse: Varg

Only for use with Python 3.6+

This package is a selection of generalised small utility classes for many use-cases in any python project, a brief description of each follow. No external dependencies, #pure-python. Warg is strictly only using standard library functionality, hopefully forever..

  • A class for easing return of multiple values, implicit handling of args and kwargs and more. Neat access options to the underlying __dict__ of the class instance, supporting almost any variation that comes to mind.

  • A class for executing any 'heavy' function asynchronously storing any results in a bounded queue. Note: communication and organisation is costly, intended for heavy processing functions and general queuing.

  • A set of utility functions for parsing/sanitising python config files, and presenting attributes using common python conventions and practices.

  • Some Mixin classes for iterating Mapping Types.

  • A single base class and metaclass, differentiating on whether subclasses singletons should be instated on own subclass basis or on the supertype.

  • A wrapper class, shorthand "GDKC", for delayed construction of class instances, with a persistent set of proposed kwargs that remain subject to change until final construction.

  • A "contract" decorator, "kw passing" is a concept that lets one make a contract with the caller that all kwargs with be passed onwards to a receiver, this lets the caller inspect available kwargs of the the receiver function allowing for autocompletion, typing and documentation fetching.

  • and more..

Disclaimer

I personally view the collection of tools as a general extensions of the python language for my workflow. I seek to provide implementations and ideas that should remain valid and useful even through future versions of the python language.
These tools are useful to me, I however suspect many of the assumptions and decisions that I made will be frowned upon by more pythonic developers, hence why I would never propose any of these tools be provided in any other way than as installable "extensions".
I seek to make the implementations quite easy to read and intuitive to experienced python developers, but I would refrain usage of "warg" if collaborating with less experienced python developers that would not inspect the implementation details of the package.

Lastly use "warg" with caution for long term projects, as some features might break as python naturally evolves in future releases. Warg uses some advanced features of python and sometimes abuse notation/syntax, with some pretty hard assumptions on parameter input and interaction.

With these rambling comments in mind please have fun with it epic_face


With great power comes great responsibility :wink:


Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

warg-1.5.3.tar.gz (81.1 kB view details)

Uploaded Source

Built Distribution

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

warg-1.5.3-py36-none-any.whl (99.9 kB view details)

Uploaded Python 3.6

File details

Details for the file warg-1.5.3.tar.gz.

File metadata

  • Download URL: warg-1.5.3.tar.gz
  • Upload date:
  • Size: 81.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for warg-1.5.3.tar.gz
Algorithm Hash digest
SHA256 d32cceee5fbc66fcfbd4d6768e50d5af7e9d3f7862cf9fd84de84bea832f300a
MD5 4fb5236137a91ae44c97bd00967ee424
BLAKE2b-256 395799759c49397558a3725064364db7e7dabc66bfb1a6fea4eeb416f207c7a0

See more details on using hashes here.

File details

Details for the file warg-1.5.3-py36-none-any.whl.

File metadata

  • Download URL: warg-1.5.3-py36-none-any.whl
  • Upload date:
  • Size: 99.9 kB
  • Tags: Python 3.6
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for warg-1.5.3-py36-none-any.whl
Algorithm Hash digest
SHA256 b9226d679da6728e30e0df0eda9a96ffcc95f2634f664870542d488b3e2b3566
MD5 248b488dd3774c33b434394b704d098c
BLAKE2b-256 0d078cccb8b90fccb629460b4923582aab319b857558d067d06c1afbf02720e0

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