forge (python) signatures for fun and profit

Release v18.5.0 (What’s new?).

forge is an elegant Python package for crafting function signatures. Its aim is to help you write better, more literate code with less boilerplate.

The power of dynamic signatures is finally within grasp – add, remove, or enhance parameters at will!

Installation

forge is a Python-only package hosted on PyPI for Python 3.6+ and PyPy 3.5+.

The recommended installation method is pip-installing into a virtualenv:

$ pip install python-forge

Overview

• Quickstart is the fastest way to discover forge.

  Start here to forge your first signature.

• Philosophy walks you through an example of forge wrapping the stdlib’s logging module.

  Read this to understand the value proposition, philosphy, and design strategy behind forge.

• Basic Usage gives a comprehensive tour of forge’s features.

  Read this to learn how to use forge - from beginner to advanced features.

• Advanced Usage shares some common use-cases and approaches for using forge.

  For example, build a function whose signature changes every call.

• API Reference has documentation for all public functionality.
• Glossary helps out iron out semantics and terms that are useful when (re-) designing function signatures.

Full Table of Contents

• Quickstart
  • Re-signing a function
  • Validating a parameter
  • Converting a parameter
• Philosophy
  • The why: intuitive design
  • The how: magic-free manipulation
  • The what: applying the knowledge
  • Design principals
  • What forge is not
  • Common names: forge.arg and forge.kwarg
• Basic Usage
  • Forging signatures
  • Adding a parameter
  • Removing a parameter
  • Renaming a parameter
  • Type annotation
  • Argument defaults
  • Argument conversion
  • Argument validation
  • Parameter metadata
  • Signature context
• Advanced Usage
  • Supplied arguments
  • Var-keyword precision
  • Transmutating parameters
  • Void arguments
  • Chameleon function
• API Reference
  • Parameter
  • Signature
  • Config
  • Marker
  • Utils
• Glossary
  • Parameter kinds
• How To Contribute
  • Workflow
  • Code
  • Tests
  • Documentation
  • Local Development Environment
  • Governance
• License and Credits
  • License
  • Credits
  • Image / Meta
• Version history

Indices and tables

• Index
• Search Page

Project information

forge is released under the MIT license, its documentation lives at Read the Docs, the code on GitHub, and the latest release on PyPI. It’s rigorously tested on Python 3.6+ and PyPy 3.5+.

forge is authored by Devin Fee. Other contributors are listed under https://github.com/dfee/forge/graphs/contributors.