Skip to main content

Add user-defined methods to Python classes.

Project description

The scattr Python package

The scattr package has one function, scattr, that provides an easy way to Set Class ATTRibutes of classes derived from pre-existing Python classes.

The scattr function takes

  • a class object and
  • the name of a helper script and returns a subclass called SubClassAttributes that contains the methods defined in the helper script.

Essentially, this is an easy way to add user-defined functions to classes.

Class variables, method and classes can be added dynamically:

import pandas as pd
import math
# add pi to a pandas DataFrame
pd.DataFrame.pi = math.pi

The scattr package provides a cleaner way to add new attributes, because it creates a new subclass and uses method and class defined in a separate helper script.

The scattr function only adds callable objects(methods and classes), not variables.

Pandas DataFrame example

import pandas as pd
from scattr import scattr

# create a new class that inherits from pd.DataFrame
# and includes methods defined in a '' file
ScattrFrame = scattr(cls=pd.DataFrame, src='helper')

# instantiate the new class
df = ScattrFrame(data=pd.read_csv('risk_factors_cervical_cancer.csv'))

# test methods added from helper file

# test CowClass added from helper file

# test method from parent class

# confirm that df is an instance of pd.DataFrame and PydyFrame
isinstance(df, (pd.DataFrame, ScattrFrame))

# confirm that ScattrFrame is a subclass of pd.DataFrame
issubclass(ScattrFrame, pd.DataFrame)

Project details

Download files

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

Source Distribution

scattr-0.0.1.tar.gz (2.1 kB view hashes)

Uploaded source

Built Distribution

scattr-0.0.1-py3-none-any.whl (2.3 kB view hashes)

Uploaded py3

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