aliaser 1.0.0.dev3

Drop-in mix-in + metaclass that let you declare any number of call-perfect aliases for a method with a single decorator or a runtime helper. No boiler-plate forwarders required.

aliaser

aliaser provides a tiny metaclass and mixin that let you expose call-perfect method aliases without writing boilerplate forwarders.

Table of Contents

• Features
• Installation
• Usage
  • Declaring aliases with @alias
  • Adding aliases at runtime
  • Avoiding the built-ins side effect
• Development
• Supported Python versions
• License

Features

• @alias decorator to expose a method or property under multiple names.
• Aliases mixin for runtime helpers, backed by the AliasMeta metaclass.
• Property and method aliases share the original descriptor – no wrappers.
• install()/uninstall() helpers manage registration of alias on builtins. install() runs automatically on import for drop-in usage.

Installation

Install from PyPI:

pip install aliaser

Or add it to a Poetry project:

poetry add aliaser

Usage

Declaring aliases with @alias

from aliaser import Aliases, alias

class Greeter(Aliases):
    @alias('hi', 'sup')
    def hello(self):
        print("Hello!")

Greeter().hi()  # prints "Hello!"

Adding aliases at runtime

Greeter.add_alias('hello', 'howdy')
Greeter().howdy()  # also prints "Hello!"

Avoiding the built-ins side effect

Importing the top-level package calls aliaser.install() which registers alias on builtins. This modifies the global namespace. Call aliaser.uninstall() to undo the side effect, or import alias from aliaser.decorator and Aliases from aliaser.mixin directly instead of importing aliaser.

Development

Clone the repository and install dependencies with Poetry:

poetry install

After making changes you can build the wheel with poetry build. Feel free to open issues or pull requests on GitHub to discuss improvements.

Supported Python versions

This project requires Python 3.12 or newer.

License

aliaser is distributed under the MIT License.