system7975%`python.module`
fault.project

Product and Project directory protocol support.

Provides three classes of interest: Project, Product, and Context. Context manages a project set formed from a sequence of Products that make up a factor search path; Projects are cached on Context instances and Products primarily provide access and updates to a product directory's index, the .product directory.

Even in the case of single product directories, a Context should be used to access the projects. The primary function of a Product instance is to merely provide access to the data stored in the index, not as a general purpose abstraction for interacting with the product directory as that function usually involves multiple directories, an abstraction provided by Context.

typing
import

collections0
import

operator0
import

itertools0
import

tools0
import

Selector
import

Segment0
import

types0
import

parse_project_index0
function

parse_project_index(lines)

Generate tuples from the given space separated fields, lines. Intended to be interpreted as a dictionary, the items' initial element should be the project's (universal) identifier. The second element is a tuple of the local name and project protocol identifier.

parse_protocol_declaration20%
function

parse_protocol_declaration(text)

Split the text and return the fields as a tuple.

structure_project_declaration285%
function

structure_project_declaration(text)

Parse the contents of a .project file.

structure_project_declaration Returns

A pair, the project protocol and a fault.project.types.Information instance.

sequence_project_declaration0
function

sequence_project_declaration()

Format the contents of a .project file from the given protocol and fault.project.types.Information structure.

scan_product_directory285%
function

scan_product_directory(read_protocol, route)

Identify the projects within the given route. Usually only used through Product.update.

protocols0
data

protocols = {
	'factors/polynomial-1': (__package__ + '.polynomial', 'V1'),
}

Product0
class

object

Project set root providing access to contexts and projects.

While often annotated as fault.route.types.Selector, usually filesystem operation must be supported by the selector.

Product project_identity_segment0
data

project_identity_segment = Segment.from_sequence(['.project', 'f-identity'])

Product default_meta_directory0
data

default_meta_directory = Segment.from_sequence(['.product'])

Product default_images_directory0
data

default_images_directory = Segment.from_sequence(['.images'])
	@classmethod

Product import_protocol0
classmethod
`types.FactorIsolationProtocol`

import_protocol(Class, identifier)

Retrieve the protocol class using the identifier.

Product project_index_route0
property
`Selector`

Materialized project index file path.

Product connections_index_route0
property
`Selector`

Connection list fulfilling requirements.

Product connections266%
property

The requirements of the product as a sequence of product directory routes.

This sequence is not cached and constructed at access time by opening the file connections_index_route.

Product clear0
method

clear(self)

Remove the instance local cache.

Product init0
method

__init__(self, route)

Initialize a Product using route with an empty local instance cache.

cache parameter is available as an override for the .product directory location, but should normally not be used.

Product hash10%
method

__hash__(self)

Product eq10%
method

__eq__(self, operand)

Product image0
method

image(self, variants, project, factor)

Identify the location of the factor's image for the given variants.

Product identifier_by_factor0
method
`typing.Tuple[str, types.FactorIsolationProtocol]`

identifier_by_factor(self, factor)

Select the project identifier and protocol using a factor path (to the project). Uses the instance local cache populated by load or update.

Product factor_by_identifier0
method
`typing.Tuple[types.FactorPath, types.FactorIsolationProtocol]`

factor_by_identifier(self, identifier)

Select the factor path (to the project) and protocol using the project identifier. Uses the instance local cache populated by load or update.

Product select736%
method
`typing.Iterable[types.FactorPath]`

select(self, constraint)

Retrieve project (path) entries that have the given prefix, constraint.

If the argument identifies a context, generate the projects contained therein. If the argument is a nil fault.project.types.FactorPath, generate all project paths.

Product read_protocol0
method

read_protocol(self, route)

Retrieve the protocol data from the configured project_declaration_filesnames.

Product _spec0
property

Product load0
method

load(self)

Load the snapshot of the projects from the product's route.

Product store0
method

store(self)

Store the snapshot of the projects to the product's route.

Product update0
method

update(self)

Update the snapshot of the projects by querying the filesystem. The effects of this should be recorded with a subsequent call to store.

Product iterprojects381%
method

iterprojects(self)

Query the route and retrieve all projects within the product.

Results may be inconsistent with the instance cache.

Product split0
method

split(self, fpath)

Separate the project portion from fpath. Returns a pair of fault.project.types.FactorPath; the project and the factor.

Project0
class

object

Project Interface joining relavant routes and protocol instances.

Project meta_directory_path0
data

meta_directory_path = Segment.from_sequence(['.project'])
	@tools.cachedproperty

Project meta0
method

meta(self)

The directory containing project metadata.

Project init0
method

__init__(self, pd, pi, pf, proto)

Project _iid_corpus_name_pair0
method

_iid_corpus_name_pair(self)

Project corpus0
property
`str`

The leading portion of the independent identifier.

Project name0
property
`str`

The name of the project as defined by the independent identifier.

Project requirements214%
method

requirements(self, context)

Identify the unique set of projects required by this project.

Project information250%
method
`types.Information`

information(self)

The identifying information of the project.

Project extensions0
method
`types.Extensions`

extensions(self)

Additional identifying information of the project.

Project icon260%
method
`bytes`

icon(self)

Read the icon reference contained in .project/icon.

Project icon Returns

b''

When the filesystem resource could not be loaded or when only whitespace is present.

Exceptions are suppressed.

bytes

The data content of the self.meta / 'icon' filesystem resource as read by files.Path.fs_load.

Project synopsis260%
method
`bytes`

synopsis(self)

Read the synopsis data contained in .project/synopsis.

Project synopsis Returns

b''

When the filesystem resource could not be loaded or when only whitespace is present.

Exceptions are suppressed.

bytes

The data content of the self.meta / 'synopsis' filesystem resource as read by files.Path.fs_load.

Project image0
method

image(self, variants, fp)

Project select0
method

select(self, factor)

Retrieve factors within the given path.

Project split80%
method

split(self, fp)

Separate the factor path from the element path. Returns a pair, fault.project.types.FactorPath and a str; the project and the factor.

Project fullsplit40%
method

fullsplit(self, qpath)

Separate the project path, factor path, and fragment path from the given fully qualified factor path.

Project refer0
method
`types.Reference`

refer(self, factorpath)

Construct a fault.project.types.Reference instance using the given factorpath.

Context0
class

object

Product and Project instance cache and search path.

Context import_protocol0
classmethod
`typing.Type[types.FactorIsolationProtocol]`

import_protocol(Class, identifier)

Retrieve the protocol class using the identifier.

Context from_product_connections0
classmethod

from_product_connections(Class, pd)

Create a Context initializing it with the immediate connections identified by pd.

Context init0
method

__init__(self)

Context connect0
method
`Product`

connect(self, route)

Add a new Product instance to the context.

Returns an existing Product instance if the route was in the cache, otherwise creates a new instance and places it in the cache.

Context project0
method
`Project`

project(self, id)

Retrieve a Project instance from the context's instance cache.

Context project Exceptions

LookupError: No project with the given identifier has been loadded in the context.

Context iterprojects0
method
`typing.Iterable[Project]`

iterprojects(self)

Generate Project instances cached from a prior load call.

This includes any Context Projects.

Context load0
method

load(self)

Fully populate the instance cache with all of the projects from all of the connected products.

Context configure0
method

configure(self)

Traverse the cached projects and apply protocol inheritance.

Context index40%
method

index(self, product)

Find the index of the Product whose route is equal to product.

Context split0
method

split(self, qpath)

Identify the product, project, and factor path of the given qpath. Returns a triple identifying the Product, Project, and remaining fault.project.types.FactorPath.

Context split Parameters

self: Undocumented.
qpath: types.FactorPath
fault.project.types.FactorPath
The qualified factor path identifying an element, factor, or project.

Context image20%
method

image(self, variants, fp)

Context refer325%
method

refer(self, factorpath)

Construct a fault.project.types.Reference from the given factorpath string.

factorpath is first processed with fault.project.types.fpc before being analyzed by split.

system7975%python.modulefault.project

typingimport

collections0import

operator0import

itertools0import

tools0import

Selectorimport

Segment0import

types0import

parse_project_index0function

parse_protocol_declaration20%function

structure_project_declaration285%function

structure_project_declarationReturns

sequence_project_declaration0function

scan_product_directory285%function

protocols0data

Product0class

Productproject_identity_segment0data

Productdefault_meta_directory0data

Productdefault_images_directory0data

Productimport_protocol0classmethodtypes.FactorIsolationProtocol

Productproject_index_route0propertySelector

Productconnections_index_route0propertySelector

Productconnections266%property

Productclear0method

Product__init__0method

Product__hash__10%method

Product__eq__10%method

Productimage0method

Productidentifier_by_factor0methodtyping.Tuple[str, types.FactorIsolationProtocol]

Productfactor_by_identifier0methodtyping.Tuple[types.FactorPath, types.FactorIsolationProtocol]

Productselect736%methodtyping.Iterable[types.FactorPath]

Productread_protocol0method

Product_spec0property

Productload0method

Productstore0method

Productupdate0method

Productiterprojects381%method

Productsplit0method

Project0class

Projectmeta_directory_path0data

Projectmeta0method

Project__init__0method

Project_iid_corpus_name_pair0method

Projectcorpus0propertystr

Projectname0propertystr

Projectrequirements214%method

Projectinformation250%methodtypes.Information

Projectextensions0methodtypes.Extensions

Projecticon260%methodbytes

ProjecticonReturns

Projectsynopsis260%methodbytes

ProjectsynopsisReturns

Projectimage0method

Projectselect0method

Projectsplit80%method

Projectfullsplit40%method

Projectrefer0methodtypes.Reference

Context0class

Contextimport_protocol0classmethodtyping.Type[types.FactorIsolationProtocol]

Contextfrom_product_connections0classmethod

Context__init__0method

Contextconnect0methodProduct

Contextproject0methodProject

ContextprojectExceptions

Contextiterprojects0methodtyping.Iterable[Project]

Contextload0method

Contextconfigure0method

Contextindex40%method

Contextsplit0method

ContextsplitParameters

Contextimage20%method

Contextrefer325%method

system7975%`python.module`
fault.project

typing
import

collections0
import

operator0
import

itertools0
import

tools0
import

Selector
import

Segment0
import

types0
import

parse_project_index0
function

parse_protocol_declaration20%
function

structure_project_declaration285%
function

structure_project_declaration Returns

sequence_project_declaration0
function

scan_product_directory285%
function

protocols0
data

Product0
class

Product project_identity_segment0
data

Product default_meta_directory0
data

Product default_images_directory0
data

Product import_protocol0
classmethod
`types.FactorIsolationProtocol`

Product project_index_route0
property
`Selector`

Product connections_index_route0
property
`Selector`

Product connections266%
property

Product clear0
method

Product init0
method

Product hash10%
method

Product eq10%
method

Product image0
method

Product identifier_by_factor0
method
`typing.Tuple[str, types.FactorIsolationProtocol]`

Product factor_by_identifier0
method
`typing.Tuple[types.FactorPath, types.FactorIsolationProtocol]`

Product select736%
method
`typing.Iterable[types.FactorPath]`

Product read_protocol0
method

Product _spec0
property

Product load0
method

Product store0
method

Product update0
method

Product iterprojects381%
method

Product split0
method

Project0
class

Project meta_directory_path0
data

Project meta0
method

Project init0
method

Project _iid_corpus_name_pair0
method

Project corpus0
property
`str`

Project name0
property
`str`

Project requirements214%
method

Project information250%
method
`types.Information`

Project extensions0
method
`types.Extensions`

Project icon260%
method
`bytes`

Project icon Returns

Project synopsis260%
method
`bytes`

Project synopsis Returns

Project image0
method

Project select0
method

Project split80%
method

Project fullsplit40%
method

Project refer0
method
`types.Reference`

Context0
class

Context import_protocol0
classmethod
`typing.Type[types.FactorIsolationProtocol]`

Context from_product_connections0
classmethod

Context init0
method

Context connect0
method
`Product`

Context project0
method
`Project`

Context project Exceptions

Context iterprojects0
method
`typing.Iterable[Project]`

Context load0
method

Context configure0
method

Context index40%
method

Context split0
method

Context split Parameters

Context image20%
method

Context refer325%
method