argsloader.units.base

UncompletedUnit

class argsloader.units.base.UncompletedUnit

Overview:

Uncompleted unit class, used when some unit structure is not completed.

__call__(v)

Calculate with given value.

Warning

This will fail due to its incompleteness.

Parameters

v – Input value.

Returns

Output value.

Raises

SyntaxError – Unit syntax error.

_fail()

Fail method, should raise error when this uncompleted unit is used.

Raises

SyntaxError – Unit syntax error.

call(v, err_mode='ALL')

Calculate with given value, similar to __call__().

Warning

This will fail due to its incompleteness.

Parameters

• v – Input value.

• err_mode – Error mode, see argsloader.base.result.ErrMode.

Raises

SyntaxError – Unit syntax error.

log(v) → argsloader.base.result.ParseResult

Get full log of this parsing process.

Warning

This will fail due to its incompleteness.

Parameters

v – Input value.

Raises

SyntaxError – Unit syntax error.

property validity

Validity of this unit.

See: argsloader.units.utils.validity().

Warning

This will fail due to its incompleteness.

BaseUnit

class argsloader.units.base.BaseUnit

__and__(other) → argsloader.units.base.BaseUnit

Build and-liked unit within units, like self & other.

See argsloader.units.operator.and_().

Parameters

other – Another unit.

Returns

And-linked unit.

__call__(v)

Calculate with given value.

Parameters

v – Input value.

Returns

Output value.

Raises

ParseError – Parse error.

__or__(other) → argsloader.units.base.BaseUnit

Build or-liked unit within units, like self | other.

See argsloader.units.operator.or_().

Parameters

other – Another unit.

Returns

Or-linked unit.

__rand__(other) → argsloader.units.base.BaseUnit

Right version of __and__(), like other & self.

Parameters

other – Another unit.

Returns

And-linked unit.

__ror__(other) → argsloader.units.base.BaseUnit

Right version of __or__(), like other | self.

See argsloader.units.operator.or_().

Parameters

other – Another unit.

Returns

Or-linked unit.

__rrshift__(other) → argsloader.units.base.BaseUnit

Right version of __rshift__(), like other >> self.

Parameters

other – Another unit.

Returns

Piped unit.

__rshift__(other) → argsloader.units.base.BaseUnit

Build pipe within units, like self >> other.

See argsloader.units.operator.pipe().

Parameters

other – Another unit.

Returns

Piped unit.

_easy_process(v: argsloader.base.value.PValue, proxy: argsloader.units.base.UnitProcessProxy) → argsloader.base.result.ParseResult

Easy process method, proxy can be used to quickly build parse result object.

Parameters

• v – PValue object.

• proxy – Proxy object.

Returns

Parse result object.

_process(v: argsloader.base.value.PValue) → argsloader.base.result.ParseResult

Protected process method.

Parameters

v – PValue input object.

Returns

Parse result object.

_skip(v: argsloader.base.value.PValue) → argsloader.base.result.ParseResult

Create a skipped result

Parameters

v – PValue object.

Returns

Skipped parse result object.

call(v, err_mode='ALL')

Calculate with given value, similar to __call__().

Parameters

• v – Input value.

• err_mode – Error mode, see argsloader.base.result.ErrMode, default is ALL.

Returns

Output value.

Raises

• ParseError – Parse error.

• MultipleParseError – Indexed parsed error, will be raised when ALL mode is used.

log(v) → argsloader.base.result.ParseResult

Get full log of this parsing process.

Parameters

v – Input value.

Returns

Parse result.

property validity

Validity of this unit.

See: argsloader.units.utils.validity().

UnitProcessProxy

class argsloader.units.base.UnitProcessProxy(unit: argsloader.units.base.BaseUnit, v: argsloader.base.value.PValue)

Overview:

Proxy class, used to create result object.

__init__(unit: argsloader.units.base.BaseUnit, v: argsloader.base.value.PValue)

Constructor of class argsloader.units.base.UnitProcessProxy.

Parameters

• unit – Unit object.

• v – PValue object.

error(err, children=None) → argsloader.base.result.ParseResult

Build an error result.

Parameters

• err – Error object, will be transformed to argsloader.base.exception.ParseError if it is not yet.

• children – Children objects.

Returns

Error parse result.

skipped() → argsloader.base.result.ParseResult

Build a skipped result.

Returns

Skipped parse result.

success(res: argsloader.base.value.PValue, children=None) → argsloader.base.result.ParseResult

Build a success result.

Parameters

• res – PValue result object.

• children – Children objects.

Returns

Success parse result.

ValueUnit

class argsloader.units.base.ValueUnit(value)

Overview:

Raw value unit.

__init__(value)

Constructor of class argsloader.units.base.ValueUnit.

Parameters

value – Raw value.

_easy_process(v: argsloader.base.value.PValue, proxy: argsloader.units.base.UnitProcessProxy) → argsloader.base.result.ParseResult

Easy process method, proxy can be used to quickly build parse result object.

Parameters

• v – PValue object.

• proxy – Proxy object.

Returns

Parse result object.

raw

argsloader.units.base.raw(v) → argsloader.units.base.ValueUnit

Raw value unit.

Parameters

v – Original value.

Returns

raw value unit.