Modules

Table of Contents

• Modules

  • anonapi package

    • anonapi.batch module

    • anonapi.client module

    • anonapi.context module

    • anonapi.decorators module

    • anonapi.exceptions module

    • anonapi.mapper module

    • anonapi.objects module

    • anonapi.parameters module

    • anonapi.responses module

    • anonapi.selection module

    • anonapi.settings module

    • anonapi.testresources module

    • Module contents

    • Examples

anonapi package

anonapi.batch module

Work with batches of jobs. Batches are modeled on git repos; state is maintained via hidden file in current folder.

class anonapi.batch.BatchFolder(path)

Bases: object

A folder in which a batch might be defined

BATCH_FILE_NAME = '.anonbatch'

__init__(path)

Parameters

path (Pathlike) – root_path to this folder

property batch_file_path

delete_batch()

Delete the batch file in this folder

Raises

BatchFolderError: – if remove does not work for some reason

has_batch()

load()

Load batch from the current folder

Return type

JobBatch

save(batch)

Save the given batch to this folder

Parameters

batch (JobBatch) – job batch to save in this folder

exception anonapi.batch.BatchFolderError

Bases: anonapi.exceptions.AnonAPIError

class anonapi.batch.JobBatch(job_ids, server)

Bases: anonapi.persistence.YAMLSerializable

A collection of anonymisation jobs

__init__(job_ids, server)

Parameters

• job_ids (List(str)) – All job ids in this batch

• server (RemoteAnonServer) – Server these jobs were created in

classmethod from_dict(dict_in)

Create object from dict. Basis for json serialization. Overwrite this in child classes to yield an instance of the child class

Raises

ValueError – If an object cannot be created from dict_in

to_dict()

Return type

str

to_string()

Batch as input

Returns

String with newlines representing this batch

Return type

str

exception anonapi.batch.NoBatchDefinedError

Bases: anonapi.exceptions.AnonAPIError

anonapi.client module

anonapi.context module

anonapi.decorators module

anonapi.exceptions module

exception anonapi.exceptions.AnonAPIError

Bases: Exception

Base exception for everything raised in anonapi

anonapi.mapper module

anonapi.objects module

classes and methods shared by anonapi modules

class anonapi.objects.RemoteAnonServer(name, url)

Bases: object

An anonymization server that can be talked to via the API

__init__(name, url)

Create a Remote anon server entry

Parameters

• name (str) – short keyword to identify this server

• url (str) – full url to a valid Anonymization server web API

classmethod from_dict(dict_in)

Load instance from output of to_dict

Return type

RemoteAnonServer

to_dict()

Dictionary representation of this server

Return type

Dict

anonapi.parameters module

anonapi.responses module

anonapi.selection module

anonapi.settings module

anonapi.testresources module

Module contents

Top-level package for AnonAPI.

Examples

To see the source code for these examples, press the [source] link to the right of each title