Coverage for pygeodesy/named.py : 95%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
# -*- coding: utf-8 -*-
all with nameable instances and several subclasses thereof.
In addition, the items in a C{_NamedDict} are accessable as attributes and the items in a C{_NamedTuple} can be named to be accessable as attributes, similar to standard Python C{namedtuple}s.
@see: Module L{pygeodesy.namedTuples} for the C{Named-Tuples}.
@newfield example: Example, Examples '''
# update imported names under if __name__ == '__main__': property_doc_, property_RO, _xcopy, _xkwds _IndexError, _IsnotError, LenError, _NameError, \ _NotImplementedError, _TypeError, _TypesError, \ _ValueError, UnitError _CURLY_, _doesn_t_exist_, _DOT_, _dot_, _DUNDER_, \ _dunder_name, _EQUAL_, _invalid_, _item_ps, _item_sq, \ joined, joined_, _name_, _other_, _PARENTH_, _SQUARE_, \ _UNDERSCORE_, _valid_
# __DUNDER gets mangled in class
'''(INTERNAL) Join C{pref} and non-empty C{name}. '''
'''(INTERNAL) Set the instance' C{.name = }B{C{name}}.
@arg inst: The instance (C{_Named}). @arg name: The name (C{str}). @kwarg force: Force name change (C{bool}).
@return: The B{C{inst}}, named if B{C{force}}d or not named before. ''' and (force or not inst.name):
'''(INTERNAL) Get C{name} and C{up} for a named C{other}. ''' else: raise _AssertionError(name, other, txt=classname(inst, prefixed=True))
'''(INTERNAL) Return a C{_TypeError} for an incompatible, named C{other}. '''
'''(INTERNAL) Check valid attribute name C{name}. ''' and name != _name_ and (_OK or not name.startswith(_UNDERSCORE_)) and (not iskeyword(name)) and isidentifier(name)) else False
'''(INTERNAL) Root class for named objects. '''
'''Default C{repr(self)}. '''
'''Default C{str(self)}. '''
'''Join attributes as C{name=value} pairs.
@arg names: The attribute names (C{str}s). @kwarg kwds: Keyword argument for function L{attrs}.
@return: All C{name=value} pairs joined (C{str}). '''
'''Get this object's C{[module.]class} name (C{str}), see property C{.classnaming} and function C{classnaming}. '''
'''Get the class naming (C{bool}), see function C{classnaming}. '''
'''Set the class naming for C{[module.].class} names.
@arg prefixed: Include the module name (C{bool}). '''
'''Create another instance of this very class.
@arg args: Optional, positional arguments. @kwarg kwds: Optional, keyword arguments.
@return: New instance (B{self.__class__}). '''
'''Make a shallow or deep copy of this instance.
@kwarg deep: If C{True} make a deep, otherwise a shallow copy (C{bool}).
@return: The copy (C{This class} or subclass thereof). '''
'''(INTERNAL) Period-join C{self.name} and C{name}. '''
'''Get the name (C{str}). '''
'''Set the name.
@arg name: New name (C{str}). ''' # to set the name from a sub-class, use # self.name = name or # _Named.name.fset(self, name), but not # _Named(self).name = name
'''Get the name I{or} class name or C{""} (C{str}). '''
'''Get the C{class} name I{and/or} the name or C{""} (C{str}). '''
'''Get the I{prefixed} C{class} name I{and/or} the name or C{""} (C{str}). '''
'''Get the C{package.module.class} name I{and/or} the name or C{""} (C{str}). ''' return _xjoined_(_dot_(self.__module__, self.__class__.__name__), self.name)
'''Default C{repr(self)}. '''
'''DEPRECATED, used method C{toRepr}.'''
'''Default C{str(self)}. ''' return str(self)
'''(INTERNAL) Set the instance' C{.name = self.name}.
@arg inst: The instance (C{_Named}). @kwarg name: Optional name, overriding C{self.name} (C{str}).
@return: The B{C{inst}}, named if not named before. '''
'''(INTERNAL) Rename the instance' C{.name = self.name}.
@arg inst: The instance (C{_Named}).
@return: The B{C{inst}}, named if not named before. ''' raise _IsnotError(_valid_, inst=inst)
inst.name = self.name
'''(INTERNAL) Base class with name. '''
'''Default C{repr(self)}. '''
'''Default C{str(self)}. '''
'''(INTERNAL) Zap cached instance attributes. ''' raise _AssertionError('.%s %s: %r' % (a, _invalid_, self))
# def notImplemented(self, attr): # '''Raise error for a missing method, function or attribute. # # @arg attr: Attribute name (C{str}). # # @raise NotImplementedError: No such attribute. # ''' # c = self.__class__.__name__ # return NotImplementedError(_dot_(c, attr))
'''Refined class comparison, invoked as C{.others(other=other)}, C{.others(name=other)} or C{.others(other, name='other')}.
@arg other: The other instance (L{any}). @kwarg name_other_up: Overriding C{name=other} and C{up=1} keyword arguments.
@return: The B{C{other}} iff compatible with this instance's C{class} or C{type}.
@raise TypeError: Mismatch of the B{C{other}} and this instance's C{class} or C{type}. ''' isinstance(self, other0.__class__):
isinstance(other, self.__class__):
raise _xotherError(self, other, name=name, up=up + 1)
'''(INTERNAL) I{Could be overloaded}.
@kwarg kwds: Optional, keyword arguments.
@return: C{toStr}() with keyword arguments (as C{str}). '''
# def toRepr(self, **kwds) # if kwds: # s = NN.join(reprs((self,), **kwds)) # else: # super().__repr__ only for Python 3+ # s = super(self.__class__, self).__repr__() # return _item_ps(self.named, s) # clips(s)
def toStr(self, **kwds): # PYCHOK no cover '''(INTERNAL) I{Must be overloaded}.
@raise AssertionError: Always, see function L{notOverloaded}. ''' notOverloaded(self, self.toStr, **kwds)
# def toStr(self, **kwds): # if kwds: # s = NN.join(strs((self,), **kwds)) # else: # super().__str__ only for Python 3+ # s = super(self.__class__, self).__str__() # return s
'''(INTERNAL) Named C{dict} with key I{and} attribute access to the items. '''
t = unstr(self.classname, *args, **kwds) raise _ValueError(args=len(args), txt=t)
'''Delete an attribute or item by B{C{name}}. ''' dict.pop(name) else:
'''Get the value of an attribute or item by B{C{name}}. ''' return _Named.name.fget(self)
'''Get the value of an item by B{C{key}}. ''' raise KeyError(_item_sq(self.classname, key))
'''Default C{repr(self)}. '''
'''Set attribute or item B{C{name}} to B{C{value}}. ''' dict.__setitem__(self, name, value) # self[name] = value else:
'''Set item B{C{key}} to B{C{value}}. ''' raise KeyError('%s = %r' % (_item_sq(self.classname, key), value))
'''Default C{str(self)}. '''
'''Like C{repr(dict)} but with C{name} and C{floats} formatting by C{fstr}. '''
'''DEPRECATED, use method C{toRepr}.'''
'''Like C{str(dict)} but with C{floats} formatting by C{fstr}. '''
'''(INTERNAL) Enum-like C{_NamedDict} with attribute access restricted to valid keys. '''
'''New C{_NamedEnum}.
@arg name: Name (C{str}). @arg Classes: One or more classes or types acceptable as enum values (C{class}- or C{type}s). '''
'''Get the value of an attribute or enum by B{C{name}}. ''' return _NamedDict.name.fget(self) raise _AttributeError(item=self._dot_(name), txt=_doesn_t_exist_)
'''Default C{repr(self)}. '''
'''Default C{str(self)}. '''
'''(INTERNAL) Check names against given, registered names. ''' and self.find(v) == a
'''Find a registered item.
@arg item: The item to look for (any C{type}).
@return: If found the B{C{item}}'s name (C{str}), C{None} otherwise. '''
'''Registed a new item.
@arg item: The item (any C{type}).
@return: The item name (C{str}).
@raise NameError: An B{C{item}} already registered with that name or the B{C{item}} has no, an empty or an invalid name.
@raise TypeError: The B{C{item}} type invalid. ''' raise ValueError except (AttributeError, ValueError, TypeError) as x: raise _NameError(_dot_('item', _name_), item, txt=str(x)) raise _NameError(self._dot_(n), item, txt='exists') raise _TypesError(self._dot_(n), item, *self._item_Classes)
'''Remove a registered item.
@arg name_or_item: Name (C{str}) of or the item (any C{type}).
@return: The unregistered item.
@raise NameError: No item with that B{C{name}}.
@raise ValueError: No such item. ''' raise _ValueError(name_or_item=name_or_item) except KeyError: raise _NameError(item=self._dot_(name), txt=_doesn_t_exist_)
'''Like C{repr(dict)} but with C{name} and C{floats} formatting by C{fstr}. '''
'''DEPRECATED, use method C{toRepr}.'''
'''Like C{str(dict)} but with C{floats} formatting by C{fstr}. '''
'''(INTERNAL) Base class for items in a C{_NamedEnum} registery. '''
'''Compare this and an other item.
@return: C{True} if different, C{False} otherwise. '''
'''(INTERNAL) Format, used by C{Conic}, C{Ellipsoid}, C{Transform}. ''' prec=prec, ints=True)
'''Get the I{registered} name (C{str}). '''
'''Set the name, unless already registered.
@arg name: New name (C{str}). ''' raise _NameError(str(name), self, txt='registered') # XXX _TypeError
'''(INTERNAL) Add this item as B{C{enum.name}}.
@note: Don't register if name is empty or doesn't start with a letter. '''
'''Remove this instance from its C{_NamedEnum} registry.
@raise AssertionError: Mismatch of this and registered item.
@raise NameError: This item is unregistered. ''' raise _AssertionError('%r vs %r' % (item, self))
'''(INTERNAL) Base for named C{tuple}s with both index I{and} attribute name access to the items.
@note: This class is similar to Python's C{namedtuple}, but statically defined, lighter and limited. ''' '''Tuple specifying the C{name} of each C{Named-Tuple} item.
@note: Specify at least 2 item names. ''' '''Tuple defining the C{units} of the value of each C{Named-Tuple} item.
@note: The C{len(_Units_)} must match C{len(_Names_)}. '''
'''New L{_NamedTuple} initialized with B{C{positional}} arguments.
@arg args: Tuple items (C{any}), all positional arguments. @kwarg name_only: Only C{B{name}='name'} is used, anu other keyword arguments are I{silently} ignored.
@raise LenError: Unequal number of positional arguments and number of item C{_Names_} or C{_Units_}.
@raise TypeError: The C{_Names_} or C{_Units_} attribute is not a C{tuple} of at least 2 items.
@raise ValueError: Item name is not a C{str} or valid C{identifier} or starts with C{underscore}. '''
raise LenError(self.__class__, args=len(args), _Names_=n)
'''Delete an attribute by B{C{name}}.
@note: Items can not be deleted. ''' raise _TypeError('del', _dot_(self.classname, name), txt=_immutable_) else: tuple.__delattr__(self, name)
'''Get the value of an attribute or item by B{C{name}}. ''' raise _IndexError(_dot_(self.classname, '<name>'), name)
'''Get the value of an item by B{C{name}}. '''
'''Default C{repr(self)}. '''
'''Set attribute or item B{C{name}} to B{C{value}}. ''' raise _TypeError(_dot_(self.classname, name), value, txt=_immutable_) else:
'''Default C{repr(self)}. '''
'''Yield the items, each as a C{(name, value)} pair (C{2-tuple}).
@see: Method C{.units}. '''
'''Get the iteration number (C{int} or C{None} if not available/applicable). '''
'''(INTERNAL) Extend this C{Named-Tuple} with C{items} to an other B{C{xTuple}}. ''' (len(self._Names_) + len(items)) == len(xTuple._Names_) and self._Names_ == xTuple._Names_[:len(self)]): raise TypeError('%s%r vs %s%r' % (self.classname, self._Names_, xTuple.__name__, xTuple._Names_))
'''Return this C{Named-Tuple} items as C{name=value} string(s).
@kwarg prec: The C{float} precision, number of decimal digits (0..9). Trailing zero decimals are stripped for B{C{prec}} values of 1 and above, but kept for negative B{C{prec}} values. @kwarg sep: Optional separator to join (C{str}).
@return: Tuple items (C{str}). '''
'''DEPRECATED, use method C{toRepr}.'''
'''Return this C{Named-Tuple} items as string(s).
@kwarg prec: The C{float} precision, number of decimal digits (0..9). Trailing zero decimals are stripped for B{C{prec}} values of 1 and above, but kept for negative B{C{prec}} values. @kwarg sep: Optional separator to join (C{str}).
@return: Tuple items (C{str}). '''
'''Return a copy of this C{Named-Tuple} with each item value wrapped as an instance of its L{units} class.
@kwarg Error: Error to raise for L{units} issues (C{UnitError}).
@return: A duplicate of this C{Named-Tuple} (C{C{Named-Tuple}}).
@raise Error: Invalid C{Named-Tuple} item or L{units} class. '''
'''Yield the items, each as a C{(name, value}) pair (C{2-tuple}) with the value wrapped as an instance of its L{units} class.
@kwarg Error: Error to raise for L{units} issues (C{UnitError}).
@raise Error: Invalid C{Named-Tuple} item or L{units} class.
@see: Method C{.items}. ''' or (isclass(U) and isinstance(v, U) and hasattr(v, _name_) and v.name == n)): # PYCHOK indent
'''(INTERNAL) One-time check of C{_Names_} and C{_Units_} for each C{_NamedUnit} I{sub-class separately}. ''' raise _TypeError(_dot_(self.classname, _Names_), ns) t = _Names_ + (_SQUARE_ % (i,)) raise _ValueError(_dot_(self.classname, t), n)
raise _TypeError(_dot_(self.classname, _Units_), us) raise LenError(self.__class__, _Units_=len(us), _Names_=len(ns)) t = _Units_ + (_SQUARE_ % (i,)) raise _TypeError(_dot_(self.classname, t), u)
'''Get the name of the calling callable.
@kwarg up: Number of call stack frames up (C{int}). @kwarg dflt: Default return value (C{any}). @kwarg source: Include source file name and line number (C{bool}).
@return: Name of the non-internal callable (C{str}) or B{C{dflt}} if none found. ''' not n.startswith(_UNDERSCORE_)): n = joined(n, _AT_, f, _COLON_, str(s)) except (AttributeError, ValueError): # PYCHOK no cover pass return dflt
'''(INTERNAL) Assemble the name for an invokation. ''' n = joined_(n, repr(self_name))
'''Return the instance' class name optionally prefixed with the module name.
@arg inst: The object (any C{type}). @kwarg prefixed: Include the module name (C{bool}), see function C{classnaming}.
@return: The B{C{inst}}'s C{[module.]class} name (C{str}). '''
'''Get/set the default class naming for C{[module.]class} names.
@kwarg prefixed: Include the module name (C{bool}).
@return: Previous class naming setting (C{bool}). '''
'''Return the class name optionally prefixed with the module name.
@arg clas: The class (any C{class}). @kwarg prefixed: Include the module name (C{bool}), see function C{classnaming}.
@return: The B{C{class}}'s C{[module.]class} name (C{str}). ''' except AttributeError: n = '--'
'''Get the name of an instance.
@arg inst: The object (any C{type}).
@return: The instance' name (C{str}) or C{""}. '''
def _notError(inst, name, args, kwds): # PYCHOK no cover '''(INTERNAL) Format an error message. ''' n = _dot_(classname(inst, prefixed=True), _dunder_name(name, name)) m = _COMMA_SPACE_.join(modulename(c, prefixed=True) for c in inst.__class__.__mro__[1:-1]) t = '%s, MRO(%s)' % (unstr(n, *args, **kwds), m) return t
def notImplemented(inst, name, *args, **kwds): # PYCHOK no cover '''Raise a C{NotImplementedError} for a missing method or property.
@arg inst: Instance (C{any}). @arg name: Method, property or name (C{str} or C{callable}). @arg args: Method or property positional arguments (any C{type}s). @arg kwds: Method or property keyword arguments (any C{type}s). ''' t = _notError(inst, name, args, kwds) raise _NotImplementedError(t, txt=notImplemented.__name__.replace('I', ' i'))
def notOverloaded(inst, name, *args, **kwds): # PYCHOK no cover '''Raise an C{AssertionError} for a method or property not overloaded.
@arg inst: Instance (C{any}). @arg name: Method, property or name (C{str} or C{callable}). @arg args: Method or property positional arguments (any C{type}s). @arg kwds: Method or property keyword arguments (any C{type}s). ''' t = _notError(inst, name, args, kwds) raise _AssertionError(t, txt=notOverloaded.__name__.replace('O', ' o'))
def _Pass(arg, **unused): # PYCHOK no cover '''(INTERNAL) I{Pass-thru} class for C{_NamedTuple._Units_}. ''' return arg
_NamedBase, # _NamedDict, _NamedEnum, _NamedEnumItem, _NamedTuple)
# **) MIT License # # Copyright (C) 2016-2020 -- mrJean1 at Gmail -- All Rights Reserved. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the "Software"), # to deal in the Software without restriction, including without limitation # the rights to use, copy, modify, merge, publish, distribute, sublicense, # and/or sell copies of the Software, and to permit persons to whom the # Software is furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL # THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR # OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, # ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR # OTHER DEALINGS IN THE SOFTWARE.
# % env PYGEODESY_FOR_DOCS=1 python -m pygeodesy.named # all 71 locals OK |