Gramps type pylint improvements

This commit is contained in:
Nick Hall 2016-01-08 21:53:44 +00:00
parent 1654757c22
commit 80f05956b4
16 changed files with 406 additions and 522 deletions

@ -23,19 +23,14 @@
Provide the different Attribute Types for Gramps. Provide the different Attribute Types for Gramps.
""" """
#-------------------------------------------------------------------------
#
# Standard Python modules
#
#-------------------------------------------------------------------------
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.gettext
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
# #
# Gramps modules # Gramps modules
# #
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
from .grampstype import GrampsType from .grampstype import GrampsType
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.gettext
class AttributeType(GrampsType): class AttributeType(GrampsType):
@ -71,8 +66,7 @@ class AttributeType(GrampsType):
(ID, _T_("Identification Number"), "Identification Number"), (ID, _T_("Identification Number"), "Identification Number"),
(NATIONAL, _T_("National Origin"), "National Origin"), (NATIONAL, _T_("National Origin"), "National Origin"),
(NUM_CHILD, _T_("Number of Children"), "Number of Children"), (NUM_CHILD, _T_("Number of Children"), "Number of Children"),
(SSN , _T_("Social Security Number"), (SSN, _T_("Social Security Number"), "Social Security Number"),
"Social Security Number"),
(NICKNAME, _T_("Nickname"), "Nickname"), (NICKNAME, _T_("Nickname"), "Nickname"),
(CAUSE, _T_("Cause"), "Cause"), (CAUSE, _T_("Cause"), "Cause"),
(AGENCY, _T_("Agency"), "Agency"), (AGENCY, _T_("Agency"), "Agency"),

@ -21,13 +21,6 @@
""" """
Provide the different child reference types. Provide the different child reference types.
""" """
#-------------------------------------------------------------------------
#
# standard python modules
#
#-------------------------------------------------------------------------
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.gettext
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
# #
@ -35,6 +28,8 @@ _ = glocale.translation.gettext
# #
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
from .grampstype import GrampsType from .grampstype import GrampsType
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.gettext
class ChildRefType(GrampsType): class ChildRefType(GrampsType):
""" """
@ -81,6 +76,3 @@ class ChildRefType(GrampsType):
def __init__(self, value=None): def __init__(self, value=None):
GrampsType.__init__(self, value) GrampsType.__init__(self, value)

@ -22,20 +22,14 @@
Provide the different event roles. Provide the different event roles.
""" """
#------------------------------------------------------------------------
#
# Python modules
#
#------------------------------------------------------------------------
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.sgettext
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
# #
# Gramps modules # Gramps modules
# #
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
from .grampstype import GrampsType from .grampstype import GrampsType
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.sgettext
class EventRoleType(GrampsType): class EventRoleType(GrampsType):
@ -82,4 +76,3 @@ class EventRoleType(GrampsType):
Returns True if EventRoleType is FAMILY, False otherwise. Returns True if EventRoleType is FAMILY, False otherwise.
""" """
return self.value == self.FAMILY return self.value == self.FAMILY

@ -23,20 +23,14 @@
Provide the different event types Provide the different event types
""" """
#------------------------------------------------------------------------
#
# Python modules
#
#------------------------------------------------------------------------
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.sgettext
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
# #
# Gramps modules # Gramps modules
# #
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
from .grampstype import GrampsType from .grampstype import GrampsType
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.sgettext
class EventType(GrampsType): class EventType(GrampsType):
""" """
@ -367,6 +361,7 @@ class EventType(GrampsType):
else: else:
abbrev = str(self) abbrev = str(self)
if " " in abbrev: if " " in abbrev:
return ".".join([letter[0].lower() for letter in abbrev.split()]) + "." return ".".join([letter[0].lower()
for letter in abbrev.split()]) + "."
else: else:
return abbrev[:3].lower() + "." return abbrev[:3].lower() + "."

@ -21,13 +21,6 @@
""" """
Provide the different family reference types. Provide the different family reference types.
""" """
#------------------------------------------------------------------------
#
# Python modules
#
#------------------------------------------------------------------------
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.gettext
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
# #
@ -36,6 +29,8 @@ _ = glocale.translation.gettext
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
from .grampstype import GrampsType from .grampstype import GrampsType
from ..config import config from ..config import config
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.gettext
class FamilyRelType(GrampsType): class FamilyRelType(GrampsType):

@ -20,7 +20,6 @@
""" """
Base type for all gramps types. Base type for all gramps types.
""" """
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
@ -54,7 +53,7 @@ class GrampsTypeMeta(type):
""" """
if blacklist: if blacklist:
return dict([(item[key_col], item[data_col]) return dict([(item[key_col], item[data_col])
for item in data if not item[0] in blacklist]) for item in data if item[0] not in blacklist])
else: else:
return dict([(item[key_col], item[data_col]) for item in data]) return dict([(item[key_col], item[data_col]) for item in data])
@ -69,16 +68,12 @@ class GrampsTypeMeta(type):
cls._E2IMAP = init_map(cls._DATAMAP, 2, 0, cls._BLACKLIST) cls._E2IMAP = init_map(cls._DATAMAP, 2, 0, cls._BLACKLIST)
# Python 2 and 3 metaclass children classes
GrampsTypeC = GrampsTypeMeta(str('GrampsTypeC'), (object, ), {})
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
# #
# GrampsType class # GrampsType class
# #
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
## python 3: class GrampsType(object, metaclass=GrampsTypeMeta): class GrampsType(object, metaclass=GrampsTypeMeta):
class GrampsType(GrampsTypeC):
"""Base class for all Gramps object types. """Base class for all Gramps object types.
:cvar _DATAMAP: :cvar _DATAMAP:
@ -108,7 +103,11 @@ class GrampsType(GrampsTypeC):
_DATAMAP = [] _DATAMAP = []
_BLACKLIST = None _BLACKLIST = None
_MENU = None _I2SMAP = {}
_S2IMAP = {}
_I2EMAP = {}
_E2IMAP = {}
_MENU = []
__slots__ = ('__value', '__string') __slots__ = ('__value', '__string')
def __getstate__(self): def __getstate__(self):
@ -126,6 +125,9 @@ class GrampsType(GrampsTypeC):
Create a new type, initialize the value from one of several possible Create a new type, initialize the value from one of several possible
states. states.
""" """
self.__value = self._DEFAULT
self.__string = ''
if value is not None:
self.set(value) self.set(value)
def __set_tuple(self, value): def __set_tuple(self, value):
@ -238,7 +240,8 @@ class GrampsType(GrampsTypeC):
""" """
default = cls() default = cls()
if struct.get("value", cls._CUSTOM) == cls._CUSTOM: if struct.get("value", cls._CUSTOM) == cls._CUSTOM:
return (struct.get("value", default.value), struct.get("string", "")) return (struct.get("value", default.value),
struct.get("string", ""))
else: else:
return (struct.get("value", default.value), '') return (struct.get("value", default.value), '')
@ -312,28 +315,5 @@ class GrampsType(GrampsTypeC):
def __ne__(self, value): def __ne__(self, value):
return not self.__eq__(value) return not self.__eq__(value)
## Python 3 does not have __cmp__
## def __cmp__(self, value):
## print ('cmp', type(value), str)
## if isinstance(value, int):
## return cmp(self.__value, value)
## elif isinstance(value, str):
## print('ok!')
## if self.__value == self._CUSTOM:
## return cmp(self.__string, value)
## else:
## print (self._I2SMAP.get(self.__value), value, cmp(self._I2SMAP.get(self.__value), value))
## return cmp(self._I2SMAP.get(self.__value), value)
## elif isinstance(value, tuple):
## if self.__value == self._CUSTOM:
## return cmp((self.__value, self.__string), value)
## else:
## return cmp(self.__value, value[0])
## else:
## if value.value == self._CUSTOM:
## return cmp(self.__string, value.string)
## else:
## return cmp(self.__value, value.value)
value = property(__int__, __set_int, None, "Returns or sets integer value") value = property(__int__, __set_int, None, "Returns or sets integer value")
string = property(__str__, __set_str, None, "Returns or sets string value") string = property(__str__, __set_str, None, "Returns or sets string value")

@ -25,20 +25,14 @@ From version 3.3 onwards, this is only kept to convert markers into tags
when loading old database files. when loading old database files.
""" """
#-------------------------------------------------------------------------
#
# Python modules
#
#-------------------------------------------------------------------------
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.gettext
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
# #
# Gramps modules # Gramps modules
# #
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
from .grampstype import GrampsType from .grampstype import GrampsType
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.gettext
class MarkerType(GrampsType): class MarkerType(GrampsType):
""" """
@ -62,4 +56,3 @@ class MarkerType(GrampsType):
def __init__(self, value=None): def __init__(self, value=None):
GrampsType.__init__(self, value) GrampsType.__init__(self, value)

@ -22,20 +22,14 @@
Name types. Name types.
""" """
#-------------------------------------------------------------------------
#
# Python modules
#
#-------------------------------------------------------------------------
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.sgettext
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
# #
# Gramps modules # Gramps modules
# #
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
from .grampstype import GrampsType from .grampstype import GrampsType
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.sgettext
class NameOriginType(GrampsType): class NameOriginType(GrampsType):
""" """
@ -94,4 +88,3 @@ class NameOriginType(GrampsType):
def __init__(self, value=None): def __init__(self, value=None):
GrampsType.__init__(self, value) GrampsType.__init__(self, value)

@ -22,20 +22,14 @@
Name types. Name types.
""" """
#-------------------------------------------------------------------------
#
# Python modules
#
#-------------------------------------------------------------------------
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.gettext
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
# #
# Gramps modules # Gramps modules
# #
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
from .grampstype import GrampsType from .grampstype import GrampsType
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.gettext
class NameType(GrampsType): class NameType(GrampsType):
@ -58,4 +52,3 @@ class NameType(GrampsType):
def __init__(self, value=None): def __init__(self, value=None):
GrampsType.__init__(self, value) GrampsType.__init__(self, value)

@ -27,16 +27,10 @@ Note types.
# Gramps modules # Gramps modules
# #
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
from .grampstype import GrampsType
from ..const import GRAMPS_LOCALE as glocale from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.sgettext _ = glocale.translation.sgettext
#-------------------------------------------------------------------------
#
# Gramps modules
#
#-------------------------------------------------------------------------
from .grampstype import GrampsType
class NoteType(GrampsType): class NoteType(GrampsType):
UNKNOWN = -1 UNKNOWN = -1
@ -73,7 +67,6 @@ class NoteType(GrampsType):
_CUSTOM = CUSTOM _CUSTOM = CUSTOM
_DEFAULT = GENERAL _DEFAULT = GENERAL
_DATAMAPREAL = [ _DATAMAPREAL = [
(UNKNOWN, _("Unknown"), "Unknown"), (UNKNOWN, _("Unknown"), "Unknown"),
(CUSTOM, _("Custom"), "Custom"), (CUSTOM, _("Custom"), "Custom"),
@ -101,8 +94,7 @@ class NoteType(GrampsType):
(SOURCEREF, _("Source Reference Note"), "Source Reference Note"), (SOURCEREF, _("Source Reference Note"), "Source Reference Note"),
(PLACE, _("Place Note"), "Place Note"), (PLACE, _("Place Note"), "Place Note"),
(REPO, _("Repository Note"), "Repository Note"), (REPO, _("Repository Note"), "Repository Note"),
(REPOREF, _("Repository Reference Note"), (REPOREF, _("Repository Reference Note"), "Repository Reference Note"),
"Repository Reference Note"),
(MEDIA, _("Media Note"), "Media Note"), (MEDIA, _("Media Note"), "Media Note"),
(MEDIAREF, _("Media Reference Note"), "Media Reference Note"), (MEDIAREF, _("Media Reference Note"), "Media Reference Note"),
(CHILDREF, _("Child Reference Note"), "Child Reference Note"), (CHILDREF, _("Child Reference Note"), "Child Reference Note"),

@ -21,13 +21,6 @@
""" """
Provide the different place types. Provide the different place types.
""" """
#------------------------------------------------------------------------
#
# Python modules
#
#------------------------------------------------------------------------
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.gettext
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
# #
@ -35,6 +28,8 @@ _ = glocale.translation.gettext
# #
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
from .grampstype import GrampsType from .grampstype import GrampsType
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.gettext
class PlaceType(GrampsType): class PlaceType(GrampsType):

@ -22,20 +22,14 @@
Repository types. Repository types.
""" """
#-------------------------------------------------------------------------
#
# Python modules
#
#-------------------------------------------------------------------------
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.gettext
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
# #
# Gramps modules # Gramps modules
# #
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
from .grampstype import GrampsType from .grampstype import GrampsType
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.gettext
class RepositoryType(GrampsType): class RepositoryType(GrampsType):
@ -70,4 +64,3 @@ class RepositoryType(GrampsType):
def __init__(self, value=None): def __init__(self, value=None):
GrampsType.__init__(self, value) GrampsType.__init__(self, value)

@ -22,20 +22,14 @@
Provide the different Source Attribute Types for Gramps. Provide the different Source Attribute Types for Gramps.
""" """
#-------------------------------------------------------------------------
#
# Standard Python modules
#
#-------------------------------------------------------------------------
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.gettext
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
# #
# Gramps modules # Gramps modules
# #
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
from .grampstype import GrampsType from .grampstype import GrampsType
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.gettext
class SrcAttributeType(GrampsType): class SrcAttributeType(GrampsType):

@ -22,20 +22,14 @@
SourceMedia types. SourceMedia types.
""" """
#-------------------------------------------------------------------------
#
# Python modules
#
#-------------------------------------------------------------------------
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.gettext
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
# #
# Gramps modules # Gramps modules
# #
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
from .grampstype import GrampsType from .grampstype import GrampsType
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.gettext
class SourceMediaType(GrampsType): class SourceMediaType(GrampsType):

@ -18,15 +18,9 @@
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
# #
"Define text formatting tag types." """
Define text formatting tag types.
#------------------------------------------------------------------------ """
#
# Python modules
#
#------------------------------------------------------------------------
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.gettext
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
# #
@ -34,6 +28,8 @@ _ = glocale.translation.gettext
# #
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
from .grampstype import GrampsType from .grampstype import GrampsType
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.gettext
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
# #
@ -41,10 +37,11 @@ from .grampstype import GrampsType
# #
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
class StyledTextTagType(GrampsType): class StyledTextTagType(GrampsType):
"""Text formatting tag type definition. """
Text formatting tag type definition.
Here we only define new class variables. For details see :class:`~gen.lib.grampstype.GrampsType`.
Here we only define new class variables. For details see
:class:`~gen.lib.grampstype.GrampsType`.
""" """
NONE_TYPE = -1 NONE_TYPE = -1
BOLD = 0 BOLD = 0

@ -22,20 +22,14 @@
URL types URL types
""" """
#-------------------------------------------------------------------------
#
# Python modules
#
#-------------------------------------------------------------------------
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.gettext
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
# #
# Gramps modules # Gramps modules
# #
#------------------------------------------------------------------------- #-------------------------------------------------------------------------
from .grampstype import GrampsType from .grampstype import GrampsType
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.gettext
class UrlType(GrampsType): class UrlType(GrampsType):
@ -60,6 +54,3 @@ class UrlType(GrampsType):
def __init__(self, value=None): def __init__(self, value=None):
GrampsType.__init__(self, value) GrampsType.__init__(self, value)