pyirk.auxiliary

Module Contents

Classes

OneToOneMapping
ListWithAttributes	This subclass of list can have attributes

Functions

ensure_list
apply_func_to_table_cells
ensure_rdf_str_literal
all_subclasses
print_inheritance_tree	Recursively print the inheritance tree of the given class.
ensure_valid_short_key
ensure_valid_uri
ensure_valid_relation_uri
ensure_valid_item_uri
ensure_valid_prefix	To avoid confusion with base_uris prefixes have to meet certain conditions.
parse_uri
ensure_valid_baseuri	:param txt: :param strict: :return:
make_uri
convert_key_str_to_num
clean_dict	Recursively remove all keys where the corresponding value is an empty list or dict.
uri_set
bright
bblue
bcyan
bmagenta
bgreen
bred
byellow
get_irk_root_dir	Return the absolute path of the irk-root (assuming the directory structure documented in README.md)
get_irk_path

Data

startup_workdir
STATEMENTS_URI_PART
PREDICATES_URI_PART
QUALIFIERS_URI_PART

API

pyirk.auxiliary.startup_workdir

‘abspath(…)’

pyirk.auxiliary.STATEMENTS_URI_PART

‘/STATEMENTS’

pyirk.auxiliary.PREDICATES_URI_PART

‘/PREDICATES’

pyirk.auxiliary.QUALIFIERS_URI_PART

‘/QUALIFIERS’

exception pyirk.auxiliary.NotYetFinishedError

Bases: NotImplementedError

class pyirk.auxiliary.OneToOneMapping(a_dict: dict = None, **kwargs)

Bases: object

Initialization

add_pair(key_a, key_b)

remove_pair(key_a=None, key_b=None, strict=True)

pyirk.auxiliary.ensure_list(arg)

class pyirk.auxiliary.ListWithAttributes

Bases: list

This subclass of list can have attributes

Initialization

Initialize self. See help(type(self)) for accurate signature.

var: Iterable

None

pyirk.auxiliary.apply_func_to_table_cells(func: callable, table: Iterable, *args, **kwargs) → pyirk.auxiliary.ListWithAttributes

pyirk.auxiliary.ensure_rdf_str_literal(arg, allow_none=True) → Union[rdflib.Literal, None]

pyirk.auxiliary.all_subclasses(cls)

pyirk.auxiliary.print_inheritance_tree(cls, prefix='')

Recursively print the inheritance tree of the given class.

exception pyirk.auxiliary.PyIRKException

Bases: Exception

raised in situations where some IRK-specific conditions are violated

Initialization

Initialize self. See help(type(self)) for accurate signature.

exception pyirk.auxiliary.GeneralPyIRKError

Bases: Exception

exception pyirk.auxiliary.MultilingualityError

Bases: pyirk.auxiliary.GeneralPyIRKError

exception pyirk.auxiliary.EmptyURIStackError

Bases: pyirk.auxiliary.GeneralPyIRKError

exception pyirk.auxiliary.UnknownPrefixError

Bases: pyirk.auxiliary.GeneralPyIRKError

exception pyirk.auxiliary.UnknownURIError

Bases: pyirk.auxiliary.GeneralPyIRKError

exception pyirk.auxiliary.InvalidURIError

Bases: pyirk.auxiliary.GeneralPyIRKError

exception pyirk.auxiliary.InvalidPrefixError

Bases: pyirk.auxiliary.GeneralPyIRKError

exception pyirk.auxiliary.InvalidShortKeyError

Bases: pyirk.auxiliary.GeneralPyIRKError

exception pyirk.auxiliary.InvalidGeneralKeyError

Bases: pyirk.auxiliary.GeneralPyIRKError

exception pyirk.auxiliary.InconsistentLabelError

Bases: pyirk.auxiliary.GeneralPyIRKError

exception pyirk.auxiliary.ShortKeyNotFoundError

Bases: pyirk.auxiliary.GeneralPyIRKError

exception pyirk.auxiliary.InvalidScopeNameError

Bases: pyirk.auxiliary.GeneralPyIRKError

exception pyirk.auxiliary.InvalidScopeTypeError

Bases: pyirk.auxiliary.GeneralPyIRKError

exception pyirk.auxiliary.ModuleAlreadyLoadedError

Bases: pyirk.auxiliary.GeneralPyIRKError

exception pyirk.auxiliary.SemanticRuleError

Bases: pyirk.auxiliary.GeneralPyIRKError

exception pyirk.auxiliary.ExplicitlyTriggeredTestException

Bases: pyirk.auxiliary.GeneralPyIRKError

exception pyirk.auxiliary.InconsistentEdgeRelations

Bases: pyirk.auxiliary.SemanticRuleError

exception pyirk.auxiliary.InvalidObjectValue

Bases: pyirk.auxiliary.SemanticRuleError

exception pyirk.auxiliary.MissingQualifierError

Bases: pyirk.auxiliary.GeneralPyIRKError

exception pyirk.auxiliary.AmbiguousQualifierError

Bases: pyirk.auxiliary.GeneralPyIRKError

exception pyirk.auxiliary.FunctionalRelationError

Bases: pyirk.auxiliary.GeneralPyIRKError

exception pyirk.auxiliary.UndefinedRelationError

Bases: pyirk.auxiliary.GeneralPyIRKError

exception pyirk.auxiliary.TaxonomicError

Bases: pyirk.auxiliary.GeneralPyIRKError

exception pyirk.auxiliary.RuleTermination

Bases: pyirk.auxiliary.PyIRKException

exception pyirk.auxiliary.LogicalContradiction

Bases: pyirk.auxiliary.RuleTermination

exception pyirk.auxiliary.ReasoningGoalReached

Bases: pyirk.auxiliary.RuleTermination

exception pyirk.auxiliary.ContinueOuterLoop

Bases: pyirk.auxiliary.PyIRKException

This is not an error but indicated that an outside loop should continue.

Initialization

Initialize self. See help(type(self)) for accurate signature.

pyirk.auxiliary.ensure_valid_short_key(txt: str, strict: bool = True) → bool

pyirk.auxiliary.ensure_valid_uri(txt: str, strict: bool = True) → bool

pyirk.auxiliary.ensure_valid_relation_uri(txt: str, strict=True)

pyirk.auxiliary.ensure_valid_item_uri(txt: str, strict=True)

pyirk.auxiliary.ensure_valid_prefix(txt: str, strict: bool = True) → bool

To avoid confusion with base_uris prefixes have to meet certain conditions.

:param txt: :param strict: :return:

pyirk.auxiliary.parse_uri(txt: str) → addict.Addict

pyirk.auxiliary.ensure_valid_baseuri(txt: str, strict: bool = True) → bool

:param txt: :param strict: :return:

pyirk.auxiliary.make_uri(base_uri: str, short_key)

pyirk.auxiliary.convert_key_str_to_num(key_str: str) → int

pyirk.auxiliary.clean_dict(dikt: Dict[Any, Union[list, dict]]) → Dict[Any, Union[list, dict]]

Recursively remove all keys where the corresponding value is an empty list or dict.

:param dikt: :return:

pyirk.auxiliary.uri_set(*args)

pyirk.auxiliary.bright(txt)

pyirk.auxiliary.bblue(txt)

pyirk.auxiliary.bcyan(txt)

pyirk.auxiliary.bmagenta(txt)

pyirk.auxiliary.bgreen(txt)

pyirk.auxiliary.bred(txt)

pyirk.auxiliary.byellow(txt)

pyirk.auxiliary.get_irk_root_dir() → str

Return the absolute path of the irk-root (assuming the directory structure documented in README.md)

:return:

pyirk.auxiliary.get_irk_path(dirname=None)