gedcom-x 0.5.7__py3-none-any.whl → 0.5.9__py3-none-any.whl

gedcomx/{PlaceDescription.py → place_description.py}

@@ -1,15 +1,16 @@
-from typing import List, Optional
+from typing import Any, Dict, List, Optional
 
 """
 ======================================================================
  Project: Gedcom-X
- File:    PlaceDescription.py
+ File:    place_description.py
  Author:  David J. Cartwright
- Purpose: Python Object representation of GedcomX PlaceDescription Type
+ Purpose: 
 
  Created: 2025-08-25
  Updated:
-   - 2025-08-31: _as_dict_ to only create entries in dict for fields that hold data
+   - 2025-09-01: filename PEP8 standard
+   - 2025-09-03: _from_json_ refactored
    
 ======================================================================
 """
@@ -19,17 +20,28 @@ from typing import List, Optional
 GEDCOM Module Types
 ======================================================================
 """
-from .Attribution import Attribution
-from .Conclusion import ConfidenceLevel
-from .Date import Date
-from .EvidenceReference import EvidenceReference
-from .Identifier import IdentifierList
-from .Note import Note
-from .Resource import Resource
-from .SourceReference import SourceReference
-from .Subject import Subject
-from .TextValue import TextValue
-from .URI import URI
+from .attribution import Attribution
+from .conclusion import ConfidenceLevel
+from .date import Date
+from .evidence_reference import EvidenceReference
+from .Extensions.rs10.rsLink import _rsLinks #new
+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
+from .logging_hub import hub, logging
+"""
+======================================================================
+Logging
+======================================================================
+"""
+log = logging.getLogger("gedcomx")
+serial_log = "gedcomx.serialization"
+#=====================================================================
+
 
 class PlaceDescription(Subject):
     """PlaceDescription describes the details of a place in terms of 
@@ -76,9 +88,11 @@ class PlaceDescription(Subject):
                  latitude: Optional[float] = None,
                  longitude: Optional[float] = None,
                  temporalDescription: Optional[Date] = None,
-                 spatialDescription: Optional[Resource] = None,) -> None:
+                 spatialDescription: Optional[Resource] = None,
+                 links: Optional[_rsLinks] = None
+                 ) -> None:
         
-        super().__init__(id, lang, sources, analysis, notes, confidence, attribution, extracted, evidence, media, identifiers)
+        super().__init__(id, lang, sources, analysis, notes, confidence, attribution, extracted, evidence, media, identifiers,links=links)
         self.names = names
         self.type = type
         self.place = place
@@ -90,8 +104,8 @@ class PlaceDescription(Subject):
 
     @property
     def _as_dict_(self):
-        from .Serialization import Serialization
-        type_as_dict = super()._as_dict_
+        from .serialization import Serialization
+        type_as_dict = super()._as_dict_ or {}
         
         if self.names:
             type_as_dict["names"] = [n._as_dict_ for n in self.names if n]
@@ -110,12 +124,46 @@ class PlaceDescription(Subject):
         if self.spatialDescription:
             type_as_dict["spatialDescription"] = self.spatialDescription._as_dict_
 
+        return type_as_dict if type_as_dict != {} else None
         return Serialization.serialize_dict(type_as_dict) 
 
     @classmethod
-    def _from_json_(cls, data: dict):
+    def _from_json_(cls, data: Any, context: Any = None) -> "PlaceDescription":
         """
         Create a PlaceDescription instance from a JSON-dict (already parsed).
-        """
-        from .Serialization import Serialization
-        return Serialization.deserialize(data, PlaceDescription)   
+        """        
+        if not isinstance(data, dict):
+            raise TypeError(f"{cls.__name__}._from_json_ expected dict or str, got {type(data)}")
+
+        person_data: Dict[str, Any] = Subject._dict_from_json_(data,context)
+
+        # names (allow both list and a single 'name' alias)
+        if (names := data.get("names")) is not None:
+            person_data["names"] = [TextValue._from_json_(n, context) for n in names]
+        
+        # type (string for now; promote to enum later)
+        if (typ := data.get("type")) is not None:
+            person_data["type"] = typ
+
+        # place: URI (accept string or dict)
+        if (pl := data.get("place")) is not None:
+            person_data["place"] = URI(pl)
+
+        # jurisdiction: Resource | PlaceDescription
+        if (jur := data.get("jurisdiction")) is not None:
+            person_data["jurisdiction"] = Resource._from_json_(jur, context)
+            
+        # coordinates
+        if (lat := data.get("latitude")) is not None:
+            person_data["latitude"] = float(lat)
+        if (lon := data.get("longitude")) is not None:
+            person_data["longitude"] = float(lon)
+
+        # temporal / spatial descriptions
+        if (td := data.get("temporalDescription")) is not None:
+            person_data["temporalDescription"] = Date._from_json_(td, context)
+
+        if (sd := data.get("spatialDescription")) is not None:
+            person_data["spatialDescription"] = Resource._from_json_(sd, context)
+
+        return cls(**person_data)   

gedcomx/{PlaceReference.py → place_reference.py}

@@ -1,7 +1,7 @@
 from __future__ import annotations
 from typing import Optional, TYPE_CHECKING
 if TYPE_CHECKING:
-    from .PlaceDescription import PlaceDescription
+    from .place_description import PlaceDescription
 
 """
 ======================================================================
@@ -13,6 +13,7 @@ if TYPE_CHECKING:
  Created: 2025-08-25
  Updated:
    - 2025-08-31: _as_dict_ to only create entries in dict for fields that hold data
+   - 2025-09-03: _from_json refactored
    
 ======================================================================
 """
@@ -22,7 +23,17 @@ if TYPE_CHECKING:
 GEDCOM Module Types
 ======================================================================
 """
-from .Resource import Resource
+from .resource import Resource
+from .logging_hub import hub, logging
+from .uri import URI
+"""
+======================================================================
+Logging
+======================================================================
+"""
+log = logging.getLogger("gedcomx")
+serial_log = "gedcomx.serialization"
+#=====================================================================
 
 class PlaceReference:
     """defines a reference to a PlaceDescription.
@@ -39,24 +50,35 @@ class PlaceReference:
     
     def __init__(self,
                  original: Optional[str] = None,
-                 description: Optional["Resource | PlaceDescription"] = None) -> None:
+                 description: Optional["URI | PlaceDescription"] = None) -> None:
         self.original = original
-        self.description = description
+        self.description = description # descriptionRef
 
     @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)
+            type_as_dict['description'] = URI(target=self.description)._as_dict_ 
+        return type_as_dict if type_as_dict != {} else None
+        
     
     @classmethod
-    def _from_json_(cls, data):
-        from .Serialization import Serialization
-        return Serialization.deserialize(data, PlaceReference)
+    def _from_json_(cls, data, context=None) -> "PlaceReference":
+        if not isinstance(data, dict):
+            raise TypeError(f"{cls.__name__}._from_json_ expected dict or str, got {type(data)}")
+
+        place_reference_data = {}
+
+        # Scalars
+        if (orig := data.get("original")) is not None:
+            place_reference_data["original"] = orig
+        if (desc := data.get("description")) is not None:
+            place_reference_data["description"] = URI._from_json_(desc, context)
+        
+        return cls(**place_reference_data)
 
 
 

gedcomx/{Qualifier.py → qualifier.py}

@@ -11,9 +11,19 @@ from typing import Optional
  Updated:
    - 2025-08-31: _as_dict_ to only create entries in dict for fields that 
    hold data, updated _from_json
+   - 2025-09-03: _from_json_ refactor
    
 ======================================================================
 """
+from .logging_hub import hub, logging
+"""
+======================================================================
+Logging
+======================================================================
+"""
+log = logging.getLogger("gedcomx")
+serial_log = "gedcomx.serialization"
+#=====================================================================
 
 class Qualifier:
     """defines the data structure used to supply additional details, annotations,
@@ -37,7 +47,7 @@ class Qualifier:
     
     @property
     def __as_dict__(self):
-        from .Serialization import Serialization
+        from .serialization import Serialization
 
         type_as_dict = {}
         if self.name:
@@ -45,10 +55,16 @@ class Qualifier:
         if self.value:
             type_as_dict["value"] = self.value
         
+        return type_as_dict if type_as_dict != {} else None
         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
+    def _from_json_(cls, data: dict, context=None) -> "Qualifier":
+        if not isinstance(data, dict):
+            raise TypeError(f"{cls.__name__}._from_json_ expected dict, got {type(data)}")
+
+        name = data.get("name")
+        value = data.get("value")
+
+        return cls(name=name, value=value)
 

gedcomx/relationship.py

@@ -0,0 +1,156 @@
+from enum import Enum
+from typing import Any, Dict, Optional, List
+"""
+======================================================================
+ Project: Gedcom-X
+ File:    relationship.py
+ Author:  David J. Cartwright
+ Purpose: 
+
+ Created: 2025-08-25
+ Updated:
+   - 2025-09-31: filename PEP8 standard
+   - 2025-09-03: _from_json_ refactor
+   
+======================================================================
+"""
+
+"""
+======================================================================
+GEDCOM Module Types
+======================================================================
+"""
+from .attribution import Attribution
+from .conclusion import ConfidenceLevel
+from .evidence_reference import EvidenceReference
+from .Extensions.rs10.rsLink import _rsLinks #new
+from .fact import Fact
+from .identifier import Identifier, make_uid
+from .note import Note
+from .person import Person
+from .resource import Resource
+from .source_reference import SourceReference
+from .subject import Subject
+from .logging_hub import hub, logging
+"""
+======================================================================
+Logging
+======================================================================
+"""
+log = logging.getLogger("gedcomx")
+serial_log = "gedcomx.serialization"
+#=====================================================================
+
+
+class RelationshipType(Enum):
+    Couple = "http://gedcomx.org/Couple"
+    ParentChild = "http://gedcomx.org/ParentChild"
+    
+    @property
+    def description(self):
+        descriptions = {
+            RelationshipType.Couple: "A relationship of a pair of persons.",
+            RelationshipType.ParentChild: "A relationship from a parent to a child."
+        }
+        return descriptions.get(self, "No description available.")
+    
+class Relationship(Subject):
+    """Represents a relationship between two Person(s)
+
+    Args:
+        type (RelationshipType): Type of relationship 
+        person1 (Person) = First Person in Relationship
+        person2 (Person): Second Person in Relationship
+
+    Raises:
+        
+    """
+    identifier = 'http://gedcomx.org/v1/Relationship'
+    version = 'http://gedcomx.org/conceptual-model/v1'
+
+    def __init__(self,
+             person1: Optional[Person | Resource] = None,
+             person2: Optional[Person | Resource] = None,
+             facts: Optional[List[Fact]] = None,  
+             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[List[Identifier]] = None,
+             type: Optional[RelationshipType] = None,
+             links: Optional[_rsLinks] = None,
+             ) -> None:
+    
+        # Call superclass initializer if required
+        super().__init__(id, lang, sources, analysis, notes, confidence, attribution, extracted, evidence, media, identifiers,links=links)
+        
+        self.id = id if id else make_uid()
+        self.type = type
+        self.person1 = person1
+        self.person2 = person2
+        self.facts = facts if facts else []
+    
+    def add_fact(self,fact: Fact):
+        if (fact is not None) and isinstance(fact,Fact):
+            for existing_fact in self.facts:
+                if fact == existing_fact:
+                    return
+            self.facts.append(fact)
+        else:
+            raise TypeError(f"Expected type 'Fact' recieved type {type(fact)}")
+
+    @property
+    def _as_dict_(self):
+        from .serialization import Serialization
+        return Serialization.serialize(self)
+        
+        type_as_dict = (super()._as_dict_ or {}).copy()
+
+        extras = {
+            "type": getattr(self.type, "value", None),
+            "person1": Resource(target=self.person1)._as_dict_ if self.person1 else None,
+            "person2": Resource(target=self.person2)._as_dict_ if self.person2 else None,
+            "facts": [f._as_dict_ for f in self.facts if f] if getattr(self, "facts", None) else None,
+        }
+
+        # only keep non-empty values
+        type_as_dict.update({k: v for k, v in extras.items() if v not in (None, [], {}, ())})
+
+        return type_as_dict or None
+
+    @classmethod
+    def _from_json_(cls, data: Dict[str, Any], context: Any = None) -> "Relationship":
+        """
+        Create a Person instance from a JSON-dict (already parsed).
+        """
+        if not isinstance(data, dict):
+            raise TypeError(f"{cls.__name__}._from_json_ expected dict, got {type(data)}")
+        
+        relationship_data: Dict[str, Any] = {}
+        relationship_data = Subject._dict_from_json_(data,context)
+
+        if (id_ := data.get("id")) is not None:
+            relationship_data["id"] = id_
+        
+        if (type_ := data.get("type")) is not None:
+            relationship_data["type"] = RelationshipType(type_)
+        
+        # person1 / person2
+        if (p1 := data.get("person1")) is not None:
+            relationship_data["person1"] = Resource._from_json_(p1,context)
+
+        if (p2 := data.get("person2")) is not None:
+            relationship_data["person2"] = Resource._from_json_(p2,context)
+
+        # facts
+        if (facts := data.get("facts")) is not None:
+            relationship_data["facts"] = [Fact._from_json_(f, context) for f in facts]
+        
+        return cls(**relationship_data)
+    

gedcomx/resource.py

@@ -0,0 +1,112 @@
+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
+   - 2025-09-03: _from_json_ refactor, arguments changed
+   
+======================================================================
+"""
+
+"""
+======================================================================
+GEDCOM Module Types
+======================================================================
+"""
+
+from .uri import URI
+from .logging_hub import hub, logging
+"""
+======================================================================
+Logging
+======================================================================
+"""
+log = logging.getLogger("gedcomx")
+serial_log = "gedcomx.serialization"
+#=====================================================================
+    
+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,resource: URI | None = None,resourceId: str | None = None, target: object = None) -> None:
+        
+        #if (resource is None) and (target is None): #TODO
+        #    raise ValueError('Resource object must point to something.')
+
+        self.resource = resource
+        self.resourceId = resourceId
+        self.Id = None
+
+        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.resourceId = target.resourceId
+                self.target = target.target
+            else:
+                log.debug(f"Target of type: {type(target)}, {target}")
+                if hasattr(target,'uri'):
+                    self.resource = target.uri
+                else:
+                    self.resourceId = URI(fragment=target.id)
+                self.resourceId = target.id
+   
+    @property
+    def uri(self):
+        return self.resource
+    
+    @property
+    def _as_dict_(self):
+        from .serialization import Serialization
+        return Serialization.serialize(self)
+        typ_as_dict = {}
+        if self.resource is not None:
+            typ_as_dict["resource"] = self.resource
+        if self.resourceId is not None:
+            typ_as_dict["resourceId"] = self.resourceId,
+        
+        return typ_as_dict or None
+
+    
+    
+    @classmethod
+    def _from_json_(cls, data: dict, context=None) -> "Resource":
+        if not isinstance(data, dict):
+            raise TypeError(f"{cls.__name__}._from_json_ expected dict, got {type(data)} {data}")
+        resource = {}
+
+        # Scalars
+        if (res := data.get("resource")) is not None:
+            resource["resource"] = res
+
+        return cls(**resource)
+
+    def __repr__(self) -> str:
+        return f"Resource(resource={self.resource}, resourceId={self.resourceId}, target={self.target})"
+    
+    def __str__(self) -> str:
+        return f"resource={self.resource}{f', resourceId={self.resourceId}' if self.resourceId else ''}"
+    
+
+