wipo-gbd-transformation 1.1.52__py3-none-any.whl → 1.1.54__py3-none-any.whl

gbdtransformation/designs/cuid/filters.py

@@ -44,4 +44,17 @@ def is_international(header):
     return False
 
 def get_ir_refnum(appnum):
-    return appnum
+    return appnum
+
+def select_earliest_date(publications):
+    return ipas.select_earliest_date(publications)
+
+def deduplicate_publication_dates(publications):
+    return ipas.deduplicate_publication_dates(publications)
+
+def deduplicate_classes(classes):
+    return ipas.deduplicate_classes(classes)
+
+def deduplicate_publications(publications):
+    return ipas.deduplicate_publications(publications)
+

gbdtransformation/designs/egid/filters.py

@@ -46,4 +46,17 @@ def is_international(header):
     return False
 
 def get_ir_refnum(appnum):
-    return appnum
+    return appnum
+
+def select_earliest_date(publications):
+    return ipas.select_earliest_date(publications)
+
+def deduplicate_publication_dates(publications):
+    return ipas.deduplicate_publication_dates(publications)
+
+def deduplicate_classes(classes):
+    return ipas.deduplicate_classes(classes)
+
+def deduplicate_publications(publications):
+    return ipas.deduplicate_publications(publications)
+

gbdtransformation/designs/filters.py

@@ -18,9 +18,16 @@ def should_display_language(lang, payload):
         return lang
     return None
 
-def st13(appnum, office, pos, type='Design', appdate=None, roffice=None, sanitize=True):
+def st13(appnum, registration_number, office, pos, type='Design', appdate=None, roffice=None, sanitize=True):
     if not appnum:
-        return None
+        # fallback to registration number (required for example by Hague pre-1999 records, which have no application number)
+        if registration_number:
+            # remove non digit prefix (we want to keep non digit char at the end of the registration number, to distinguish
+            # non unitary registration numbers from the same application, e.g. D054966 and D054966A)
+            registration_number = re.sub(r"^[^0-9]+", '', registration_number)
+            appnum = 'R' + registration_number
+        else:
+            return None
     # collections are usually office code followed with tm: xxtm
     collection = '%sid' % office.lower()
 
@@ -63,4 +70,4 @@ def st13(appnum, office, pos, type='Design', appdate=None, roffice=None, sanitiz
         st13 = '%s%s' % (st13, appdate[:4])
 
     # add application number and zfill till 17
-    return '%s%s.%s' % (st13, appnum.zfill(17 - len(st13)), pos)
+    return '%s%s' % (st13, appnum.zfill(17 - len(st13)))

gbdtransformation/designs/idid/filters.py

@@ -51,4 +51,17 @@ def is_international(header):
     return False
 
 def get_ir_refnum(appnum):
-    return appnum
+    return appnum
+
+def select_earliest_date(publications):
+    return ipas.select_earliest_date(publications)
+
+def deduplicate_publication_dates(publications):
+    return ipas.deduplicate_publication_dates(publications)
+
+def deduplicate_classes(classes):
+    return ipas.deduplicate_classes(classes)
+
+def deduplicate_publications(publications):
+    return ipas.deduplicate_publications(publications)
+

gbdtransformation/designs/ipas/filters.py

@@ -64,6 +64,89 @@ def get_registration_date(trademark, tmstatus):
             if event.MarkEventCode == 'Published':
                 return event.MarkEventDate
 
+# given a list of dates as strings, e.g. publication dates, deduplicate
+def deduplicate_dates(dates):
+    return list(set(dates))
+
+# given a list of publications, deduplicate
+def deduplicate_publication_dates(design):
+    if design == None:
+        return None
+    dates = []
+    if "PublicationDetails" in design:
+        publicationDetails = design["PublicationDetails"]
+        publications = publicationDetails.get('Publication', [])
+        if not isinstance(publications, list): 
+            publications = [publications]
+        for publication in publications:
+            if "PublicationDate" in publication:
+                dates.append(publication["PublicationDate"])
+    return deduplicate_dates(dates)
+
+# given a list of classes, deduplicate
+def deduplicate_classes(classes):
+    deduplicate_classes = []
+    if not isinstance(classes, list): 
+        classes = [classes]
+    for the_class in classes:
+        if the_class["ClassNumber"] not in deduplicate_classes:
+            deduplicate_classes.append(the_class["ClassNumber"])
+    result = []
+    for deduplicate_class in deduplicate_classes:
+        result.append({ "code": deduplicate_class} )
+    return result
+
+# given a list of publications, deduplicate
+def deduplicate_publications(publications):
+    deduplicate_publications = []
+    pub_keys = []
+    if not isinstance(publications, list): 
+        publications = [publications]
+    for publication in publications:
+        publication_date = publication.get("PublicationDate")
+        publication_identifier = publication.get("PublicationIdentifier")
+        pub_key = ""
+        if publication_identifier:
+            pub_key += publication_identifier
+        if publication_date:
+            pub_key += publication_date
+        if pub_key not in pub_keys:
+            deduplicate_publications.append(publication)
+            pub_keys.append(pub_key)
+    result = []
+    for publication in deduplicate_publications:
+        res = {}
+        if "PublicationIdentifier" in publication:
+            res["identifier"] = publication["PublicationIdentifier"]
+        if "PublicationDate" in publication:
+            res["date"] = publication["PublicationDate"]
+        result.append(res)
+    return result
+
+# given a list of publications with dates as strings, select the earliest date publication
+def select_earliest_date(design):
+    if design == None:
+        return None
+
+    if "PublicationDetails" in design:
+        publicationDetails = design["PublicationDetails"]
+        publications = publicationDetails.get('Publication', [])
+        if not isinstance(publications, list): 
+            publications = [publications]
+        if len(publications) == 0:
+            return None
+        elif len(publications) == 1:
+            return publications[0]["PublicationDate"]
+        else:
+            earliest_date = None
+            n = -1
+            for count, publication in enumerate(publications):
+                if earliest_date == None or publication["PublicationDate"] < earliest_date:
+                    earliest_date = publication["PublicationDate"]
+            return earliest_date
+    else:
+        return None
+
 def translate_status(status):
     status = status.lower()
 

gbdtransformation/designs/ipas/template.yml

@@ -2,7 +2,7 @@
 
 {% call(header) match('DesignTransactionBody.TransactionContentDetails', Transaction) %}
 
-{% call(design) match('TransactionData.DesignApplicationDetails.DesignApplication', header) %}
+{% set design = Transaction.DesignTransactionBody.TransactionContentDetails.TransactionData.DesignApplicationDetails.DesignApplication %}
 {% set design_count = design | get_designs_count(header) %}
 {% set design_pos = design | get_designs_pos(header) %}
 {% set kind = design | translate_kind(header) %}
@@ -35,13 +35,16 @@ reference:
 {% set idstatus = design.DesignDetails.Design | translate_status %}
 {% set appdate = design.DesignApplicationDate | get_appdate(design.DesignApplicationNumber) %}
 
-st13: {{ design.DesignApplicationNumber | st13(design.RegistrationOfficeCode, design_pos, appdate=appdate, roffice=design.ReceivingOfficeCode) }}
+st13: {{ design.DesignApplicationNumber | st13(None, design.RegistrationOfficeCode, design_pos, appdate=appdate, roffice=design.ReceivingOfficeCode) }}
 
 applicationNumber: {{ design.DesignApplicationNumber }}
 applicationDate: {{ design.DesignApplicationDate }}
 registrationNumber: {{ design.DesignDetails.Design | get_registration_nb(idstatus) | remove_trailing('-') }}
 registrationDate: {{ design.DesignDetails.Design | get_registration_date(idstatus) }}
-publicationDate: {{ (design.DesignDetails.Design.PublicationDetails.Publication | last).PublicationDate }}
+
+publicationDates: {{ design.DesignDetails.Design | deduplicate_publication_dates }}
+earliestPublicationDate: {{ design.DesignDetails.Design | select_earliest_date }}
+
 expiryDate: {{ design.DesignDetails.Design | get_expiry_date(idstatus) }}
 
 applicationLanguageCode: {{ design.DesignApplicationLanguageCode }}
@@ -143,13 +146,9 @@ designs:
       - kind: {{ indicationProducts.ClassificationKindCode | lower }}
         version: {{ indicationProducts.ClassificationVersion}}
         classes:
-        {% call(code) match('ClassDescriptionDetails.ClassDescription', indicationProducts) %}
-          - code: {{ code.ClassNumber }}
-            description: {{ code.ProductDescription}}
-        {% endcall %}
+          - {{ indicationProducts.ClassDescriptionDetails.ClassDescription | deduplicate_classes }}
     {% endcall %}
 
-
     priorities:
       {% call(priority) match('PriorityDetails.Priority', design.DesignDetails.Design) %}
         - countryCode: {{ priority.PriorityCountryCode }}
@@ -161,14 +160,15 @@ designs:
     {% call(indic) match('NoveltyStatement', design.DesignDetails.Design) %}
       - languageCode: {{ indic | remove_trailing('-', '.')  | guess_language(indic._languageCode, design.DesignApplicationLanguageCode) }}
         text: {{ indic | remove_trailing('-', '.') }}
-      {% endcall %}
+    {% endcall %}
+
+    {% set earliestDesignPub = design.DesignDetails.Design.PublicationDetails.Publication | select_earliest_date %}
+    earliestPublications:
+      identifier: {{ earliestDesignPub.PublicationIdentifier}}
+      date: {{ earliestDesignPub.PublicationDate}}
+      section:
 
     publications:
-      {% call(pub) match('PublicationDetails.Publication', design.DesignDetails.Design) %}
-      - identifier: {{ pub.PublicationIdentifier}}
-        date: {{ pub.PublicationDate}}
-        section:
-      {% endcall %}
+      - {{ design.DesignDetails.Design.PublicationDetails.Publication | deduplicate_publications }}
 
 {% endcall %}
-{% endcall %}

gbdtransformation/designs/joid/filters.py

@@ -46,4 +46,17 @@ def is_international(header):
     return False
 
 def get_ir_refnum(appnum):
-    return appnum
+    return appnum
+
+def select_earliest_date(publications):
+    return ipas.select_earliest_date(publications)
+
+def deduplicate_publication_dates(publications):
+    return ipas.deduplicate_publication_dates(publications)
+
+def deduplicate_classes(classes):
+    return ipas.deduplicate_classes(classes)
+
+def deduplicate_publications(publications):
+    return ipas.deduplicate_publications(publications)
+

gbdtransformation/designs/keid/filters.py

@@ -46,4 +46,17 @@ def is_international(header):
     return False
 
 def get_ir_refnum(appnum):
-    return appnum
+    return appnum
+
+def select_earliest_date(publications):
+    return ipas.select_earliest_date(publications)
+
+def deduplicate_publication_dates(publications):
+    return ipas.deduplicate_publication_dates(publications)
+
+def deduplicate_classes(classes):
+    return ipas.deduplicate_classes(classes)
+
+def deduplicate_publications(publications):
+    return ipas.deduplicate_publications(publications)
+

gbdtransformation/designs/khid/filters.py

@@ -47,4 +47,17 @@ def is_international(header):
     return False
 
 def get_ir_refnum(appnum):
-    return appnum
+    return appnum
+
+def select_earliest_date(publications):
+    return ipas.select_earliest_date(publications)
+
+def deduplicate_publication_dates(publications):
+    return ipas.deduplicate_publication_dates(publications)
+
+def deduplicate_classes(classes):
+    return ipas.deduplicate_classes(classes)
+
+def deduplicate_publications(publications):
+    return ipas.deduplicate_publications(publications)
+

gbdtransformation/designs/laid/filters.py

@@ -46,4 +46,16 @@ def is_international(header):
     return False
 
 def get_ir_refnum(appnum):
-    return appnum
+    return appnum
+
+def select_earliest_date(publications):
+    return ipas.select_earliest_date(publications)
+
+def deduplicate_publication_dates(publications):
+    return ipas.deduplicate_publication_dates(publications)
+
+def deduplicate_classes(classes):
+    return ipas.deduplicate_classes(classes)
+
+def deduplicate_publications(publications):
+    return ipas.deduplicate_publications(publications)

gbdtransformation/designs/mnid/filters.py

@@ -46,4 +46,17 @@ def is_international(header):
     return False
 
 def get_ir_refnum(appnum):
-    return appnum
+    return appnum
+
+def select_earliest_date(publications):
+    return ipas.select_earliest_date(publications)
+
+def deduplicate_publication_dates(publications):
+    return ipas.deduplicate_publication_dates(publications)
+
+def deduplicate_classes(classes):
+    return ipas.deduplicate_classes(classes)
+
+def deduplicate_publications(publications):
+    return ipas.deduplicate_publications(publications)
+

gbdtransformation/designs/myid/filters.py

@@ -45,4 +45,16 @@ def is_international(header):
     return False
 
 def get_ir_refnum(appnum):
-    return appnum
+    return appnum
+
+def select_earliest_date(publications):
+    return ipas.select_earliest_date(publications)
+
+def deduplicate_publication_dates(publications):
+    return ipas.deduplicate_publication_dates(publications)
+
+def deduplicate_classes(classes):
+    return ipas.deduplicate_classes(classes)
+
+def deduplicate_publications(publications):
+    return ipas.deduplicate_publications(publications)

gbdtransformation/designs/phid/filters.py

@@ -55,4 +55,16 @@ def is_international(header):
     return False
 
 def get_ir_refnum(appnum):
-    return appnum
+    return appnum
+
+def select_earliest_date(publications):
+    return ipas.select_earliest_date(publications)
+
+def deduplicate_publication_dates(publications):
+    return ipas.deduplicate_publication_dates(publications)
+
+def deduplicate_classes(classes):
+    return ipas.deduplicate_classes(classes)
+
+def deduplicate_publications(publications):
+    return ipas.deduplicate_publications(publications)

gbdtransformation/designs/sgid/filters.py

@@ -50,4 +50,17 @@ def is_international(header):
     return False
 
 def get_ir_refnum(appnum):
-    return appnum
+    return appnum
+
+def select_earliest_date(publications):
+    return ipas.select_earliest_date(publications)
+
+def deduplicate_publication_dates(publications):
+    return ipas.deduplicate_publication_dates(publications)
+
+def deduplicate_classes(classes):
+    return ipas.deduplicate_classes(classes)
+
+def deduplicate_publications(publications):
+    return ipas.deduplicate_publications(publications)
+

gbdtransformation/designs/thid/filters.py

@@ -49,4 +49,16 @@ def is_international(header):
     return False
 
 def get_ir_refnum(appnum):
-    return appnum
+    return appnum
+
+def select_earliest_date(publications):
+    return ipas.select_earliest_date(publications)
+
+def deduplicate_publication_dates(publications):
+    return ipas.deduplicate_publication_dates(publications)
+
+def deduplicate_classes(classes):
+    return ipas.deduplicate_classes(classes)
+
+def deduplicate_publications(publications):
+    return ipas.deduplicate_publications(publications)

gbdtransformation/designs/tnid/filters.py

@@ -51,4 +51,16 @@ def is_international(header):
         return True
 
 def get_ir_refnum(appnum):
-    return appnum
+    return appnum
+
+def select_earliest_date(publications):
+    return ipas.select_earliest_date(publications)
+
+def deduplicate_publication_dates(publications):
+    return ipas.deduplicate_publication_dates(publications)
+
+def deduplicate_classes(classes):
+    return ipas.deduplicate_classes(classes)
+
+def deduplicate_publications(publications):
+    return ipas.deduplicate_publications(publications)

gbdtransformation/designs/vnid/filters.py

@@ -47,4 +47,16 @@ def is_international(header):
     return False
 
 def get_ir_refnum(appnum):
-    return appnum
+    return appnum
+
+def select_earliest_date(publications):
+    return ipas.select_earliest_date(publications)
+
+def deduplicate_publication_dates(publications):
+    return ipas.deduplicate_publication_dates(publications)
+
+def deduplicate_classes(classes):
+    return ipas.deduplicate_classes(classes)
+
+def deduplicate_publications(publications):
+    return ipas.deduplicate_publications(publications)

gbdtransformation/designs/woid/filters.py

@@ -3,6 +3,7 @@ from gbdtransformation.designs import kinds as std_kinds
 from gbdtransformation.designs import status as std_status
 from gbdtransformation.designs.filters import st13
 from datetime import datetime, date
+import json 
 
 # namespaces defined in XML and to be ignored in procecssing
 ignore_namespace = [ "http://www.wipo.int/standards/XMLSchema/ST96/Design", 
@@ -87,14 +88,15 @@ def getRefusalDate(histories, designIdentifier=None, countryCode=None):
     '''
     # check refusal
     refusalDate = None
-    for history in histories:
-        if "HagueRefusal" in history:
-            if designIdentifier == None or isAffectedDesignIdentifier(designIdentifier, history.HagueRefusal.AffectedDesign):
-                if countryCode == None or isApplicableToCountry(countryCode, history.HagueRefusal):
-                    if "DecisionEffectiveDate" in history.HagueRefusal:
-                        refusalDate = history.HagueRefusal.DecisionEffectiveDate
-                    elif "DecisionDate" in history.HagueRefusal:
-                        refusalDate = history.HagueRefusal.DecisionDate
+    if histories != None:
+        for history in histories:
+            if "HagueRefusal" in history:
+                if designIdentifier == None or isAffectedDesignIdentifier(designIdentifier, history.HagueRefusal.AffectedDesign):
+                    if countryCode == None or isApplicableToCountry(countryCode, history.HagueRefusal):
+                        if "DecisionEffectiveDate" in history.HagueRefusal:
+                            refusalDate = history.HagueRefusal.DecisionEffectiveDate
+                        elif "DecisionDate" in history.HagueRefusal:
+                            refusalDate = history.HagueRefusal.DecisionDate
     return refusalDate
 
 def build_person_name(name_struct):
@@ -169,7 +171,7 @@ def format_complete_address(PostalStructuredAddress):
 def getOfficeStatusDate(registrationDate, expiryDate, histories, designIdentifier, countryCode=None):
     expiryDate = getExpiryDate(expiryDate, histories, designIdentifier)
     grantedDate = None
-    if countryCode != None:
+    if countryCode != None and histories != None:
         # check possible renunciation including the particular country if specified
         for history in histories:
             if "HagueRenunciation" in history:
@@ -236,7 +238,7 @@ def getGbdStatus(registrationDate, expiryDate, histories, designIdentifier, coun
     # if we have specified a country, check if the country is not part of a renunciation,
     # then the status would be Ended for all design following Hague XML schema explanations
     grantedDate = None
-    if countryCode != None:
+    if countryCode != None and histories != None:
         for history in histories:
             if "HagueRenunciation" in history:
                 # is the design identifier in the list of affected designs?
@@ -326,17 +328,36 @@ def isApplicableToCountry(countryCode, hagueHistoryEvent):
     '''
     Return True if the history event is applicable to the provided country 
     '''
+    if hagueHistoryEvent is None:
+        return False
+
     if "RecordNotifyingOfficeCode" in hagueHistoryEvent:
         if hagueHistoryEvent.RecordNotifyingOfficeCode == countryCode:
             return True
     elif "DesignatedCountryBag" in hagueHistoryEvent:
-        if "DesignatedCountry" in hagueHistoryEvent.DesignatedCountryBag:
-            for designatedCountry in hagueHistoryEvent.DesignatedCountryBag.DesignatedCountry:
-                if isinstance(designatedCountry, str):
-                    if hagueHistoryEvent.DesignatedCountryBag.DesignatedCountry.DesignatedCountryCode  == countryCode:
+        if hagueHistoryEvent.DesignatedCountryBag is not None:
+            if "DesignatedCountry" in hagueHistoryEvent.DesignatedCountryBag:
+                for designatedCountry in hagueHistoryEvent.DesignatedCountryBag.DesignatedCountry:
+                    if isinstance(designatedCountry, str):
+                        if hagueHistoryEvent.DesignatedCountryBag.DesignatedCountry.DesignatedCountryCode  == countryCode:
+                            return True
+                    elif designatedCountry.DesignatedCountryCode == countryCode:
                         return True
-                elif designatedCountry.DesignatedCountryCode == countryCode:
-                    return True
     return False
 
+"""
+Functions dedicated to Hague transaction history  
+"""
+
+transaction_header_elements = [ "HagueBulletinNumber", "PublicationDate" ]
+
+def get_event_type(history):
+    for child in history:
+        if child.startswith("_"):
+            continue
+        if child not in transaction_header_elements:
+            return child
+    return None
 
+def serialize(history):
+    return json.loads(history.toJSON())