gedcom-x 0.5.6__py3-none-any.whl → 0.5.8__py3-none-any.whl

gedcomx/{Person.py → person.py}

@@ -1,22 +1,38 @@
-from enum import Enum
 from typing import List, Optional
 from urllib.parse import urljoin
 
-from .Attribution import Attribution
-from .Conclusion import ConfidenceLevel
-from .Date import Date
-from .EvidenceReference import EvidenceReference
-from .Fact import Fact, FactType
-from .Gender import Gender, GenderType
-from .Identifier import IdentifierList
-from .Name import Name, QuickName
-from .Note import Note
-from .SourceReference import SourceReference
-from .Serialization import Serialization
-from .Subject import Subject
-from .Resource import Resource
-from collections.abc import Sized
+"""
+======================================================================
+ Project: Gedcom-X
+ File:    Person.py
+ Author:  David J. Cartwright
+ Purpose: Python Object representation of GedcomX Person Type
+
+ Created: 2025-08-25
+ Updated:
+   - 2025-08-31: _as_dict_ to only create entries in dict for fields that hold data
+   
+======================================================================
+"""
+
+"""
+======================================================================
+GEDCOM Module Types
+======================================================================
+"""
+from .attribution import Attribution
+from .conclusion import ConfidenceLevel
+from .date import Date
+from .evidence_reference import EvidenceReference
 from .Extensions.rs10.rsLink import _rsLinkList
+from .fact import Fact, FactType
+from .gender import Gender, GenderType
+from .identifier import IdentifierList
+from .name import Name, QuickName
+from .note import Note
+from .resource import Resource
+from .source_reference import SourceReference
+from .subject import Subject
 
 class Person(Subject):
     """A person in the system.
@@ -40,7 +56,7 @@ class Person(Subject):
              notes: Optional[List[Note]] = None,
              confidence: Optional[ConfidenceLevel] = None,
              attribution: Optional[Attribution] = None,
-             extracted: bool = None,
+             extracted: Optional[bool] = None,
              evidence: Optional[List[EvidenceReference]] = None,
              media: Optional[List[SourceReference]] = None,
              identifiers: Optional[IdentifierList] = None,
@@ -77,6 +93,7 @@ class Person(Subject):
                     return False
             self.facts.append(fact_to_add)
             return True
+        return False
 
     def add_name(self, name_to_add: Name) -> bool:
         if len(self.names) > 5: 
@@ -89,9 +106,10 @@ class Person(Subject):
                     return False
             self.names.append(name_to_add)
             return True
+        return False
     
     def _add_relationship(self, relationship_to_add: object):
-        from .Relationship import Relationship
+        from .relationship import Relationship
         if isinstance(relationship_to_add,Relationship):
             self._relationships.append(relationship_to_add)
         else:
@@ -102,7 +120,7 @@ class Person(Subject):
         "ascendancyNumber": "1",
         "deathDate": "from 2001 to 2005",
         "descendancyNumber": "1",
-        "gender": self.gender.type,
+        "gender": self.gender.type if self.gender else 'Unknown',
         "lifespan": "-2005",
         "name": self.names[0].nameForms[0].fullText
             }
@@ -111,17 +129,20 @@ class Person(Subject):
 
     @property
     def _as_dict_(self):
-        type_as_dict = super()._as_dict_  # Start with base class fields
-        # Only add Relationship-specific fields
-        type_as_dict.update({
-            'private': self.private,
-            'living': self.living,
-            'gender': self.gender._as_dict_ if self.gender else None,
-            'names': [name._as_dict_ for name in self.names],
-            'facts': [fact._as_dict_ for fact in self.facts],
-            'uri': self.uri._as_dict_ if self.uri else None
-                           
-        })
+        from .serialization import Serialization
+        type_as_dict = super()._as_dict_  
+        if self.private is not None:
+            type_as_dict['private'] = self.private
+        if self.living is not None:
+            type_as_dict['living'] = self.living
+        if self.gender:
+            type_as_dict['gender'] = self.gender._as_dict_
+        if self.names:
+            type_as_dict['names'] = [n._as_dict_ for n in self.names if n]
+        if self.facts:
+            type_as_dict['facts'] = [f._as_dict_ for f in self.facts if f]
+        if self.uri:
+            type_as_dict['uri'] = self.uri._as_dict_
 
         return Serialization.serialize_dict(type_as_dict)
            
@@ -130,10 +151,12 @@ class Person(Subject):
         """
         Create a Person instance from a JSON-dict (already parsed).
         """
+        from .serialization import Serialization
         return Serialization.deserialize(data, Person)
 
     @classmethod
     def from_familysearch(cls, pid: str, token: str, *, base_url: Optional[str] = None):
+        from .serialization import Serialization
         """
         Fetch a single person by PID from FamilySearch and return a Person.
         - pid: e.g. "KPHP-4B4"

gedcomx/place_description.py

@@ -0,0 +1,123 @@
+from typing import List, Optional
+
+"""
+======================================================================
+ Project: Gedcom-X
+ File:    place_description.py
+ Author:  David J. Cartwright
+ Purpose: 
+
+ Created: 2025-08-25
+ Updated:
+   - 2025-09-01: filename PEP8 standard
+   
+======================================================================
+"""
+
+"""
+======================================================================
+GEDCOM Module Types
+======================================================================
+"""
+from .attribution import Attribution
+from .conclusion import ConfidenceLevel
+from .date import Date
+from .evidence_reference import EvidenceReference
+from .identifier import IdentifierList
+from .note import Note
+from .resource import Resource
+from .source_reference import SourceReference
+from .subject import Subject
+from .textvalue import TextValue
+from .uri import URI
+#=====================================================================
+
+
+class PlaceDescription(Subject):
+    """PlaceDescription describes the details of a place in terms of 
+    its name and possibly its type, time period, and/or a geospatial description
+    functioning as a description of a place as a snapshot in time.
+
+    Encapsulates textual names, geospatial coordinates, jurisdictional context,
+    temporal coverage, and related resources (media, sources, evidence, etc.).
+    
+
+    Attributes:
+        names (Optional[List[TextValue]]): Human-readable names or labels for
+            the place (e.g., “Boston, Suffolk, Massachusetts, United States”).
+        type (Optional[str]): A place type identifier (e.g., a URI). **TODO:**
+            replace with an enumeration when finalized.
+        place (Optional[URI]): Canonical identifier (URI) for the place.
+        jurisdiction (Optional[Resource|PlaceDescription]): The governing or
+            containing jurisdiction of this place (e.g., county for a town).
+        latitude (Optional[float]): Latitude in decimal degrees (WGS84).
+        longitude (Optional[float]): Longitude in decimal degrees (WGS84).
+        temporalDescription (Optional[Date]): Temporal coverage/validity window
+            for this description (e.g., when a jurisdictional boundary applied).
+        spatialDescription (Optional[Resource]): A resource describing spatial
+            geometry or a link to an external gazetteer/shape definition.
+    """
+    identifier = "http://gedcomx.org/v1/PlaceDescription"
+    version = 'http://gedcomx.org/conceptual-model/v1'
+
+    def __init__(self, id: Optional[str] =None,
+                 lang: Optional[str] = None,
+                 sources: Optional[List[SourceReference]] = None,
+                 analysis: Optional[Resource] = None,
+                 notes: Optional[List[Note]] =None,
+                 confidence: Optional[ConfidenceLevel] = None,
+                 attribution: Optional[Attribution] = None,
+                 extracted: Optional[bool] = None,
+                 evidence: Optional[List[EvidenceReference]] = None,
+                 media: Optional[List[SourceReference]] = None,
+                 identifiers: Optional[IdentifierList] = None,
+                 names: Optional[List[TextValue]] = None,
+                 type: Optional[str] = None,    #TODO This needs to be an enumerated value, work out details
+                 place: Optional[URI] = None,
+                 jurisdiction: Optional["Resource | PlaceDescription"] = None, 
+                 latitude: Optional[float] = None,
+                 longitude: Optional[float] = None,
+                 temporalDescription: Optional[Date] = None,
+                 spatialDescription: Optional[Resource] = None,) -> None:
+        
+        super().__init__(id, lang, sources, analysis, notes, confidence, attribution, extracted, evidence, media, identifiers)
+        self.names = names
+        self.type = type
+        self.place = place
+        self.jurisdiction = jurisdiction
+        self.latitude = latitude
+        self.longitude = longitude
+        self.temporalDescription = temporalDescription
+        self.spatialDescription = spatialDescription
+
+    @property
+    def _as_dict_(self):
+        from .serialization import Serialization
+        type_as_dict = super()._as_dict_
+        
+        if self.names:
+            type_as_dict["names"] = [n._as_dict_ for n in self.names if n]
+        if self.type:
+            type_as_dict["type"] = self.type    #TODO
+        if self.place:
+            type_as_dict["place"] = self.place._as_dict_
+        if self.jurisdiction:
+            type_as_dict["jurisdiction"] = self.jurisdiction._as_dict_ 
+        if self.latitude is not None: # include 0.0; exclude only None
+            type_as_dict["latitude"] = float(self.latitude)
+        if self.longitude is not None: # include 0.0; exclude only None
+            type_as_dict["longitude"] = float(self.longitude)
+        if self.temporalDescription:
+            type_as_dict["temporalDescription"] = self.temporalDescription._as_dict_
+        if self.spatialDescription:
+            type_as_dict["spatialDescription"] = self.spatialDescription._as_dict_
+
+        return Serialization.serialize_dict(type_as_dict) 
+
+    @classmethod
+    def _from_json_(cls, data: dict):
+        """
+        Create a PlaceDescription instance from a JSON-dict (already parsed).
+        """
+        from .serialization import Serialization
+        return Serialization.deserialize(data, PlaceDescription)   

gedcomx/place_reference.py

@@ -0,0 +1,62 @@
+from __future__ import annotations
+from typing import Optional, TYPE_CHECKING
+if TYPE_CHECKING:
+    from .place_description import PlaceDescription
+
+"""
+======================================================================
+ Project: Gedcom-X
+ File:    PlaceReference.py
+ Author:  David J. Cartwright
+ Purpose: Python Object representation of GedcomX PlaceReference Type
+
+ Created: 2025-08-25
+ Updated:
+   - 2025-08-31: _as_dict_ to only create entries in dict for fields that hold data
+   
+======================================================================
+"""
+
+"""
+======================================================================
+GEDCOM Module Types
+======================================================================
+"""
+from .resource import Resource
+
+class PlaceReference:
+    """defines a reference to a PlaceDescription.
+
+    
+    Attributes:
+        original (Optional[str]): The unnormalized, user- or source-provided place text.
+            Keep punctuation and ordering exactly as recorded in the source.
+        description (Optional[Resource|PlaceDescription]): A :class:`gedcomx.PlaceDescription` Object or pointer to it. (URI/:class:`~Resource`)
+
+    """
+    identifier = 'http://gedcomx.org/v1/PlaceReference'
+    version = 'http://gedcomx.org/conceptual-model/v1'
+    
+    def __init__(self,
+                 original: Optional[str] = None,
+                 description: Optional["Resource | PlaceDescription"] = None) -> None:
+        self.original = original
+        self.description = description
+
+    @property
+    def _as_dict_(self):
+        from .serialization import Serialization
+        type_as_dict = {}
+        if self.original:
+            type_as_dict['original'] = self.original
+        if self.description:
+            type_as_dict['description'] = self.description._as_dict_ 
+        return Serialization.serialize_dict(type_as_dict)
+    
+    @classmethod
+    def _from_json_(cls, data):
+        from .serialization import Serialization
+        return Serialization.deserialize(data, PlaceReference)
+
+
+

gedcomx/qualifier.py

@@ -0,0 +1,54 @@
+from typing import Optional
+
+"""
+======================================================================
+ Project: Gedcom-X
+ File:    Qualifier.py
+ Author:  David J. Cartwright
+ Purpose: Python Object representation of GedcomX Qualifier Type
+
+ Created: 2025-08-25
+ Updated:
+   - 2025-08-31: _as_dict_ to only create entries in dict for fields that 
+   hold data, updated _from_json
+   
+======================================================================
+"""
+
+class Qualifier:
+    """defines the data structure used to supply additional details, annotations,
+    tags, or other qualifying data to a specific data element.
+
+    
+    Attributes:
+        name str: The name of the Qualifier. *It is RECOMMENDED that the qualifier 
+            name resolve to an element of a constrained vocabulary.*
+            
+        value (Optional[str]): The value of the Qualifier. *If provided, the name 
+            MAY give the semantic meaning of the value.*
+
+    """
+    identifier = 'http://gedcomx.org/v1/Qualifier'
+    version = 'http://gedcomx.org/conceptual-model/v1'
+    
+    def __init__(self, name: str, value: Optional[str]) -> None:
+        self.name = name
+        self.value = value
+    
+    @property
+    def __as_dict__(self):
+        from .serialization import Serialization
+
+        type_as_dict = {}
+        if self.name:
+            type_as_dict["name"] = self.name
+        if self.value:
+            type_as_dict["value"] = self.value
+        
+        return Serialization.serialize_dict(type_as_dict)
+    
+    @classmethod
+    def _from_json(cls,data):
+        qualifier = Qualifier(name=data.get('name',"ERROR: This Qualifier require a 'name' but has none."),value=data.get('value'))
+        return qualifier
+

gedcomx/{Relationship.py → relationship.py}

@@ -1,18 +1,36 @@
 from enum import Enum
 from typing import List, Optional
+"""
+======================================================================
+ Project: Gedcom-X
+ File:    relationship.py
+ Author:  David J. Cartwright
+ Purpose: 
 
-from .Attribution import Attribution
-from .Conclusion import ConfidenceLevel
-from .EvidenceReference import EvidenceReference
-from .Fact import Fact
-from .Identifier import Identifier
-from .Note import Note
-from .Person import Person
-from .Serialization import Serialization
-from .SourceReference import SourceReference
-from .Resource import Resource
+ Created: 2025-08-25
+ Updated:
+   - 2025-09-31: filename PEP8 standard
+   
+======================================================================
+"""
+
+"""
+======================================================================
+GEDCOM Module Types
+======================================================================
+"""
+from .attribution import Attribution
+from .conclusion import ConfidenceLevel
+from .evidence_reference import EvidenceReference
+from .fact import Fact
+from .identifier import Identifier
+from .note import Note
+from .person import Person
+from .resource import Resource
+from .source_reference import SourceReference
+from .subject import Subject
+#=====================================================================
 
-from .Subject import Subject
 
 class RelationshipType(Enum):
     Couple = "http://gedcomx.org/Couple"
@@ -77,11 +95,12 @@ class Relationship(Subject):
 
     @property
     def _as_dict_(self):
+        from .serialization import Serialization
         type_as_dict = super()._as_dict_
         type_as_dict.update({
             "type": self.type.value if isinstance(self.type, RelationshipType) else self.type,
-            "person1": self.person1._as_dict_ if self.person1 else None,
-            "person2": self.person2._as_dict_ if self.person2 else None,
+            "person1": Resource(target=self.person1)._as_dict_ if self.person1 else None,
+            "person2": Resource(target=self.person1)._as_dict_ if self.person2 else None,
             "facts": [fact for fact in self.facts] if self.facts else None
         })
         return Serialization.serialize_dict(type_as_dict)
@@ -91,5 +110,6 @@ class Relationship(Subject):
         """
         Create a Person instance from a JSON-dict (already parsed).
         """
+        from .serialization import Serialization
         return Serialization.deserialize(data, Relationship)
     

gedcomx/resource.py

@@ -0,0 +1,85 @@
+from typing import Optional
+
+"""
+======================================================================
+ Project: Gedcom-X
+ File:    Resource.py
+ Author:  David J. Cartwright
+ Purpose: References TopLevel Types for Serialization
+
+ Created: 2025-08-25
+ Updated:
+   - 2025-08-31: working on target=Resource and deserialization issues
+   
+======================================================================
+"""
+
+"""
+======================================================================
+GEDCOM Module Types
+======================================================================
+"""
+
+from .uri import URI
+    
+class Resource:
+    """
+    Class used to track and resolve URIs and references between datastores.
+
+    Parameters
+    ----------
+    
+    Raises
+    ------
+    ValueError
+        If `id` is not a valid UUID.
+    """
+    # TODO, Deal with a resouce being passed, as it may be unresolved.
+    def __init__(self,uri: Optional[URI|str] = None, id:Optional[str] = None,top_lvl_object: Optional[object] = None,target= None) -> None:
+        
+        self.resource = URI.from_url(uri.value) if isinstance(uri,URI) else URI.from_url(uri) if isinstance(uri,str) else None
+        self.Id = id
+
+        self.type = None
+        self.resolved = False
+        self.target: object = target
+        self.remote: bool | None = None    # is the resource pointed to persitent on a remote datastore?
+
+        if target:
+            if isinstance(target,Resource):
+                self.resource = target.resource
+                self.Id = target.Id
+                self.target = target.target
+            else:
+                self.resource = target.uri
+                self.Id = target.id
+                self.type = type(target)
+   
+    @property
+    def uri(self):
+        return self.resource
+    
+    @property
+    def _as_dict_(self):
+        from .serialization import Serialization
+        typ_as_dict = {}
+        if self.resource:
+            typ_as_dict['resource'] = self.resource.value if self.resource else None
+        if self.Id:
+            typ_as_dict['resourceId'] = self.Id
+        return Serialization.serialize_dict(typ_as_dict)
+    
+    @classmethod
+    def _from_json_(cls,data):
+        # TODO This is not used but taken care of in Serialization
+        r = Resource(uri=data.get('resource'),id=data.get('resourceId',None))
+        #return r
+
+    def __repr__(self) -> str:
+        return f"Resource(uri={self.resource}, id={self.Id}, target={self.target})"
+    
+    def __str__(self) -> str:
+        return f"{self.resource}{f', id={self.Id}' if self.Id else ''}"
+    
+
+