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.4.8.tar.gz (78.7 kB view details)

Uploaded Source

Built Distribution

Warg-1.4.8-py36-none-any.whl (98.6 kB view details)

Uploaded Python 3.6

File details

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

File metadata

  • Download URL: warg-1.4.8.tar.gz
  • Upload date:
  • Size: 78.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for warg-1.4.8.tar.gz
Algorithm Hash digest
SHA256 8e0892828b9ec6bf8bf5d5b31b2fcecc86810be9915a1564fe8b33cd88b30511
MD5 ab888ee4d6cde20f46cc1880595a193a
BLAKE2b-256 0d074768fbd9a7e8ab0c09d31d33eaa92d098e4fda7ac2dd5c211f0bd3fc6779

See more details on using hashes here.

File details

Details for the file Warg-1.4.8-py36-none-any.whl.

File metadata

  • Download URL: Warg-1.4.8-py36-none-any.whl
  • Upload date:
  • Size: 98.6 kB
  • Tags: Python 3.6
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for Warg-1.4.8-py36-none-any.whl
Algorithm Hash digest
SHA256 9bc268855317c63462f7d16e8a2e664f24b0ead1edcfb6e4f4ab54878090198f
MD5 b9ac7a0359c6c5b6a54e73a32f1ed647
BLAKE2b-256 ded1d2c1f5dda23e931e72f146d696a921e57952e0d7ff30d954d89bdaa823f8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page