Create string representations of classes

This module contains a class used to generate __repr__ methods for your classes. This can be done either by inheriting from the SimpleRepr class, or by creating a __repr__ function, and returing SimpleRepr.make_repr(self)

Using the SimpleRepr class

Inheritance

The easiest way to use this class is to inherit from it, as this saves you from defining a __repr__ method altogether.

from simple_repr import SimpleRepr


class User(SimpleRepr):
    def __init__(self, name: str, age: int):
        self.name = name
        self.age = age


user = User('John', 25)
print(user)

>>> "User(args[name='John', age=25])"

Inheriting from SimpleRepr allows for the inclusion of class constants.

from simple_repr import SimpleRepr


class User(SimpleRepr):

    COMPANY = "Some Company"

    def __init__(self, name: str, age: int):
        self.name = name
        self.age = age


user = User('John', 25)
print(user)

>>> "User(consts=[COMPANY='Some Company'], args[name='John', age=25])"

Defining a function

In case you don't want to inherit from the SimpleRepr class, or are already inheriting from another class, you can create a __repr__ function and return the staticmethod make_repr from the module.

from simple_repr import SimpleRepr


class User:
    def __init__(self, name: str, age: int):
        self.name = name
        self.age = age

    def __repr__(self) -> str:
        return SimpleRepr().make_repr(self)


user = User('John', 25)
print(user)

>>> "User(args=[name='John', age=25])"

The downside to defining your own function is that class constants are no longer accessible, and therefore will not be included in the repr.

from simple_repr import SimpleRepr


class User:

    COMPANY = "Some Company"

    def __init__(self, name: str, age: int):
        self.name = name
        self.age = age

    def __repr__(self) -> str:
        return SimpleRepr().make_repr(self)


user = User('John', 25)
print(user)

>>> "User(args[name='John', age=25])"

Creating an environment

Create a virtual development environment by using the virtualenv Python library. You can install this by executing pip install virtualenv.

To create your environment, type virtualenv venv --prompt "(your-env) ". Once created, you can activate it by using source venv/bin/activate. Once you are done developing, simply type deactivate in your terminal.

Installation

Using the library

• Install this library by running pip install simple-repr.
• Import the library by adding from simple_repr import SimpleRepr to your code.

Developing for this library

• Install the Python libraries required by running pip install -r dev-requirements.txt.
• Before making any commits, ensure that all nox sessions are passing.

Please ensure to create your environment before you execute any of the installation commands