Base

Base class

Base class for all classes in the package. It provides rich printing and persistence of objects.

class edsl.Base.Base

Bases: RepresentationMixin, PersistenceMixin, DiffMethodsMixin, HashingMixin, ABC

Base class for all classes in the package.

abstract code()

This method should be implemented by subclasses.

abstract example()

This method should be implemented by subclasses.

abstract from_dict()

This method should be implemented by subclasses.

keys()

Return the keys of the object.

show_methods(show_docstrings=True)

Show the methods of the object.

store(d: dict, key_name: str | None = None)

abstract to_dict()

This method should be implemented by subclasses.

to_json()

values()

Return the values of the object.

class edsl.Base.DiffMethodsMixin

Bases: object

class edsl.Base.HashingMixin

Bases: object

class edsl.Base.PersistenceMixin

Bases: object

Mixin for saving and loading objects to and from files.

create_download_link()

classmethod delete(uuid: str | UUID | None = None, url: str | None = None)

Delete the object from coop.

classmethod load(filename)

Load the object from a file.

>>> obj = cls.load("obj.json.gz")

static open_compressed_file(filename)

static open_regular_file(filename)

classmethod patch(uuid: str | UUID | None = None, url: str | None = None, description: str | None = None, alias: str | None = None, value: Any | None = None, visibility: str | None = None)

Patch an uploaded objects attributes. - description changes the description of the object on Coop - value changes the value of the object on Coop. has to be an EDSL object - visibility changes the visibility of the object on Coop

classmethod pull(uuid: str | UUID | None = None, url: str | None = None, expected_parrot_url: str | None = None)

Pull the object from coop.

push(description: str | None = None, alias: str | None = None, visibility: str | None = 'unlisted', expected_parrot_url: str | None = None)

Post the object to coop.

save(filename, compress=True)

Save the object to a file as zippped JSON.

>>> obj.save("obj.json.gz")

classmethod search(query)

Search for objects on coop.

store(d: dict, key_name: str | None = None)

class edsl.Base.RegisterSubclassesMeta(name, bases, namespace, /, **kwargs)

Bases: ABCMeta

Metaclass for registering subclasses.

static get_registry(exclude_classes: list | None = None)

Return the registry of subclasses.

class edsl.Base.RepresentationMixin

Bases: object

display_dict()

help()

Extract all public instance methods and their docstrings from a class instance.

Args:

obj: The instance to inspect

Returns:

dict: A dictionary where keys are method names and values are their docstrings

json()

print(format='rich')

to_dataset()

view()

Displays an interactive / perspective view of the object

edsl.Base.is_iterable(obj)