wipo-gbd-transformation 1.1.36__py3-none-any.whl → 1.1.37__py3-none-any.whl

gbdtransformation/brands/xxtm/template.yml

@@ -0,0 +1,183 @@
+{% from 'navigation.tmpl' import match %}
+
+# common filter methods accessible in this template
+# gbdtransformation.common.filters
+#   .convertdate
+#   .contains
+#   .append
+#   .guess_language
+#   . ...
+# gbdtransformation.brands.filters
+#   .st13
+#   .pad_vienna
+#   .split_terms (for goods and services)
+#
+# TESTING:
+# developing the template:
+#   see the transformation output:
+#       gbd-transform /data/brands/collections/xxtm/ xxtm -t1
+#   test for transformation errors:
+#       gbd-transform /data/brands/collections/xxtm/ xxtm -r200 -w4 -q
+# validating the template:
+#   gbd-transform /data/brands/collections/xxtm/ xxtm -r2000 -w40 -q --qc
+
+brand:
+  type: # (TRADEMARK|EMBLEM|AOP|INN)
+  kind: # (Individual|Collective|Certificate|Guarantee|Defensive|Other)
+  markFeature: # (Word|Stylized characters|Figurative|Combined|Three dimensional|Colour|Sound|Hologram|Olfactory|Motion|Municipal|Chimney|Other|Undefined)
+
+  registrationOfficeCode:
+  designatedCountries:
+    - str (CountryCode)
+
+  # rarely passed
+  filingPlace:
+
+  # some collections indicate that the application
+  # originates from international filing and provide IR number
+  # (question to ask in GBD participation questionnaire)
+  applicationRefNumber:
+  applicationRefOrigin:
+
+  # can be deduced from appnum given office cc and (optional) appdate
+  st13: # {{ Trademark.ApplicationNumber | st13('XX', appdate=... }}
+
+  applicationNumber:
+  # dates can be converted if not matching expected format
+  applicationDate: # ex: {{ Trademark.ApplicationDate | convertdate('%Y%m%d') }}
+
+  # some collections have registration number
+  # equals application number when registered
+  registrationNumber:
+  # some collections we can guess registration date
+  # from event list
+  registrationDate:
+
+  applicationLanguageCode:
+  # rarely passed
+  secondLanguageCode:
+
+  expiryDate:
+  # rarely passed
+  terminationDate:
+
+  # status as is in the document
+  officeStatus:
+  # status as translated to gbdFormat
+  gbdStatus:  # (Ended|Expired|Pending|Registered|Unknown)
+  # can also be the date of the last event in markevents if given
+  statusDate:
+
+  markDisclaimerDetails:
+    - languageCode: # use guess_language to set it if not passed
+                    # ex {{ Trademark.MarkDisclaimerDetails | guess_language(lang='..', default='..') }}
+                    #   lang: the language if provided in doc
+                    #   default: default language if lang not provided.
+                    #   if no lang no default => use langdetect library
+      text:
+
+  markDescriptionDetails:
+    - languageCode:
+      text:
+
+  wordMarkSpecification:
+    markVerbalElement:
+      - languageCode:
+        text:
+    markSignificantVerbalElement:
+      - languageCode:
+        text:
+    markTranslation:
+      - languageCode:
+        text:
+    markTransliteration:
+
+  markImageDetails:
+    - name:
+      colourIndicator:
+      colourClaimed:
+        - languageCode:
+          text:
+      classification:
+        kind: Vienna #mostly
+        version: 7 #mostly
+        code:
+          - string
+
+  markSoundDetails:
+    - filename:
+      fileformat:
+
+  markVideo:
+    - filename:
+      fileformat:
+
+  goodsServices:
+    - nice:
+      version: 11 #mostly
+      terms:
+        - languageCode:
+          text:
+
+  # some datasets have goods and services
+  # terms that are not classified under a
+  # nice class
+  goodsServicesceUnclassified:
+    - languageCode:
+      text:
+
+  priorities:
+    - countryCode:
+      number:
+      date:
+      comment:
+
+  publications:
+    - identifier:
+      date:
+      section:
+
+  applicants:
+    - identifier:
+      kind:
+      fullName:
+        - languageCode:
+          text:
+      fullAddress:
+        - languageCode:
+          text:
+      countryCode: # sometimes, country name is provided instead
+
+  representatives:
+    - identifier:
+      kind:
+      fullName:
+        - languageCode:
+          text:
+      fullAddress:
+        - languageCode:
+          text:
+      countryCode:
+
+  correspondence:
+    fullName:
+      - languageCode:
+        text:
+    fullAddress:
+      - languageCode:
+        text:
+    countryCode:
+
+  events:
+    - officeKind:
+      gbdKind: # Filed, Registered, Published, Pending, Inactive,
+               # Opposed, Withdrawn, Expired, Examined, Invalidated,
+               # Rejected, Abandoned, Suspended, Surrendered, Appealed,
+               # Awaiting court action, Converted, Notification, Unknown
+      date:
+
+ appeals:
+    - kind:
+      date:
+  # here goes extra information that is office specific and that is pertinent for us to retain.
+  extra:

gbdtransformation/common/filters.py

@@ -73,15 +73,21 @@ def to_str(input):
 # split goods and services terms
 def split_terms(data, separator=';'):
     """ Splits text base on seprator"""
-
     if not data:
         return []
     elif hasattr(data, '__value'): data = data.__value
 
     if not data:
         return []
-    terms = [str(x).strip() for x in data.split(separator) if str(x).strip()]
-    terms = [x for x in terms if x != 'true' and x != 'false']
+    terms = []
+    if type(data) == list:
+        for d in data:
+            tmp = [str(x).strip() for x in d.split(separator) if str(x).strip()]
+            tmp = [x for x in tmp if x != 'true' and x != 'false']
+            terms.extend(tmp)
+    else:
+        terms = [str(x).strip() for x in data.split(separator) if str(x).strip()]
+        terms = [x for x in terms if x != 'true' and x != 'false']
     return terms
 
 

gbdtransformation/designs/alid/__init__.py

@@ -0,0 +1,5 @@
+render = 'JSON'
+source = 'national'
+
+# AL/I/1996/000003
+appnum_mask = 'AL/(I|E|D)/\\d*/(\\d*)'

gbdtransformation/designs/alid/filters.py

@@ -0,0 +1,56 @@
+# standard gbd definitions
+import gbdtransformation.designs.ipas.filters as ipas
+
+
+# namespaces defined in XML and to be ignored in procecssing
+ignore_namespace = [
+   'http://www.wipo.int/standards/XMLSchema/designs',
+   'http://www.wipo.int/standards/XMLSchema/wo-designs'
+]
+def get_appdate(appdate, appnum):
+    return appnum.split('/')[-2]
+
+def get_designs_count(design, header):
+    return '1'
+
+def get_designs_pos(design, header):
+    return '1'
+def translate_kind(desgin, header):
+    code = header.TransactionCode.lower()
+    subcode = header.TransactionSubCode.lower()
+    if code == 'disenjo industriale':
+        return 'Industrial Design'
+    raise Exception('Type "%s" "%s" is not mapped.' % (code, subcode))
+
+def translate_status(design):
+    status = design.DesignCurrentStatusCode
+
+    if status == '2295': return 'Unknown'
+    if status == '2353': return 'Unknown'
+    if status == '2366': return 'Unknown'
+    if status == '2387': return 'Unknown'
+    if status == '2389': return 'Unknown'
+    if status == '2394': return 'Unknown'
+    if status == 'Reinstated': return 'Pending'
+
+    return ipas.translate_status(status)
+
+
+def get_registration_nb(design, idstatus):
+    if design.RegistrationNumber:
+        return design.RegistrationNumber
+
+    return None
+
+
+def get_expiry_date(design, idstatus):
+    return ipas.get_expiry_date(design, idstatus)
+
+def get_registration_date(design, idstatus):
+    return ipas.get_registration_date(design, idstatus)
+
+def is_international(header):
+    return False
+
+def get_ir_refnum(appnum):
+    return appnum

gbdtransformation/designs/alid/schema

@@ -0,0 +1,89 @@
+/Transaction
+__/DesignTransactionBody
+____/TransactionContentDetails
+______/TransactionCode
+______/TransactionData
+________/DesignApplicationDetails
+__________/DesignApplication
+____________/ApplicantDetails
+______________/ApplicantKey
+____________/DesignApplicationDate
+____________/DesignApplicationLanguageCode
+____________/DesignApplicationNumber
+____________/DesignDetails
+______________/Design
+________________/ApplicantDetails
+__________________/Applicant
+____________________/ApplicantAddressBook
+______________________/FormattedNameAddress
+________________________/Address
+__________________________/AddressCountryCode
+__________________________/FreeFormatAddress
+____________________________/FreeFormatAddressLine
+________________________/Name
+__________________________/FreeFormatName
+____________________________/FreeFormatNameDetails
+______________________________/FreeFormatNameLine
+______________________________/FreeFormatNameLine[@languageCode=sq]
+________________/DesignCurrentStatusCode
+________________/DesignCurrentStatusDate
+________________/DesignDescription
+________________/DesignIdentifier
+________________/DesignRepresentationSheetDetails
+__________________/DesignRepresentationSheet
+____________________/RepresentationSheetFilename
+________________/DesignTitle
+________________/DesignTitle[@languageCode=sq]
+________________/DesignTitle[@sequenceNumber=1]
+________________/DesignerDetails
+__________________/Designer
+____________________/DesignerAddressBook
+______________________/FormattedNameAddress
+________________________/Address
+__________________________/AddressCountryCode
+__________________________/FreeFormatAddress
+____________________________/FreeFormatAddressLine
+________________________/Name
+__________________________/FreeFormatName
+____________________________/FreeFormatNameDetails
+______________________________/FreeFormatNameLine
+______________________________/FreeFormatNameLine[@languageCode=sq]
+________________/ExpiryDate
+________________/IndicationProductDetails
+__________________/IndicationProduct
+____________________/ClassDescriptionDetails
+______________________/ClassDescription
+________________________/ClassNumber
+________________________/ProductDescription
+____________________/ClassificationKindCode
+____________________/ClassificationVersion
+________________/NoveltyStatement
+________________/NoveltyStatement[@languageCode=]
+________________/NoveltyStatement[@languageCode=sq]
+________________/PriorityDetails
+__________________/Priority
+____________________/PriorityCountryCode
+____________________/PriorityDate
+____________________/PriorityNumber
+________________/PublicationDetails
+__________________/Publication
+____________________/PublicationDate
+____________________/PublicationIdentifier
+________________/RegistrationDate
+________________/RegistrationNumber
+________________/RepresentativeDetails
+__________________/Representative
+____________________/RepresentativeAddressBook
+______________________/FormattedNameAddress
+________________________/Address
+__________________________/AddressCountryCode
+__________________________/FreeFormatAddress
+____________________________/FreeFormatAddressLine
+________________________/Name
+__________________________/FreeFormatName
+____________________________/FreeFormatNameDetails
+______________________________/FreeFormatNameLine
+______________________________/FreeFormatNameLine[@languageCode=sq]
+____________/RegistrationOfficeCode
+______/TransactionIdentifier
+______/TransactionSubCode

gbdtransformation/designs/alid/template.yml

@@ -0,0 +1 @@
+{% include "ipas/template.yml" %}

gbdtransformation/designs/bnid/__init__.py

@@ -0,0 +1,5 @@
+render = 'JSON'
+source = 'national'
+
+# BN/2009/0025
+appnum_mask = 'BN/\\d*/(\\d*)'

gbdtransformation/designs/bnid/filters.py

@@ -0,0 +1,57 @@
+# standard gbd definitions
+import gbdtransformation.designs.ipas.filters as ipas
+
+
+# namespaces defined in XML and to be ignored in procecssing
+ignore_namespace = [
+   'http://www.wipo.int/standards/XMLSchema/designs',
+   'http://www.wipo.int/standards/XMLSchema/wo-designs'
+]
+def get_appdate(appdate, appnum):
+    return appnum.split('/')[-2]
+
+def get_designs_count(design, header):
+    return '1'
+
+def get_designs_pos(design, header):
+    return '1'
+
+def translate_kind(desgin, header):
+    code = header.TransactionCode.lower()
+    subcode = header.TransactionSubCode.lower()
+    if code == 'industrial design':
+        return 'Industrial Design'
+    raise Exception('Type "%s" "%s" is not mapped.' % (code, subcode))
+
+def translate_status(design):
+    status = design.DesignCurrentStatusCode
+
+    if status == '2295': return 'Unknown'
+    if status == '2353': return 'Unknown'
+    if status == '2366': return 'Unknown'
+    if status == '2387': return 'Unknown'
+    if status == '2389': return 'Unknown'
+    if status == '2394': return 'Unknown'
+    if status == 'Reinstated': return 'Pending'
+
+    return ipas.translate_status(status)
+
+
+def get_registration_nb(design, idstatus):
+    if design.RegistrationNumber:
+        return design.RegistrationNumber
+
+    return None
+
+
+def get_expiry_date(design, idstatus):
+    return ipas.get_expiry_date(design, idstatus)
+
+def get_registration_date(design, idstatus):
+    return ipas.get_registration_date(design, idstatus)
+
+def is_international(header):
+    return False
+
+def get_ir_refnum(appnum):
+    return appnum

gbdtransformation/designs/bnid/schema

@@ -0,0 +1,80 @@
+/Transaction
+__/DesignTransactionBody
+____/TransactionContentDetails
+______/TransactionCode
+______/TransactionData
+________/DesignApplicationDetails
+__________/DesignApplication
+____________/ApplicantDetails
+______________/ApplicantKey
+____________/DesignApplicationDate
+____________/DesignApplicationLanguageCode
+____________/DesignApplicationNumber
+____________/DesignDetails
+______________/Design
+________________/ApplicantDetails
+__________________/Applicant
+____________________/ApplicantAddressBook
+______________________/FormattedNameAddress
+________________________/Address
+__________________________/AddressCountryCode
+__________________________/FreeFormatAddress
+____________________________/FreeFormatAddressLine
+________________________/Name
+__________________________/FreeFormatName
+____________________________/FreeFormatNameDetails
+______________________________/FreeFormatNameLine
+______________________________/FreeFormatNameLine[@languageCode=en]
+________________/DesignCurrentStatusCode
+________________/DesignCurrentStatusDate
+________________/DesignDescription
+________________/DesignEventDetails
+__________________/DesignEvent
+____________________/DesignEventCode
+____________________/DesignEventDate
+____________________/OfficeSpecificDesignEventCode
+____________________/OfficeSpecificDesignEventDescription
+____________________/OfficeSpecificDesignEventDescription[@languageCode=en]
+________________/DesignIdentifier
+________________/DesignRepresentationSheetDetails
+__________________/DesignRepresentationSheet
+____________________/RepresentationSheetFilename
+________________/DesignTitle
+________________/DesignTitle[@languageCode=en]
+________________/DesignTitle[@sequenceNumber=1]
+________________/IndicationProductDetails
+__________________/IndicationProduct
+____________________/ClassDescriptionDetails
+______________________/ClassDescription
+________________________/ClassNumber
+________________________/ProductDescription
+____________________/ClassificationKindCode
+____________________/ClassificationVersion
+________________/NoveltyStatement
+________________/NoveltyStatement[@languageCode=en]
+________________/PriorityDetails
+__________________/Priority
+____________________/PriorityCountryCode
+____________________/PriorityDate
+____________________/PriorityNumber
+________________/PublicationDetails
+__________________/Publication
+____________________/PublicationDate
+________________/RegistrationDate
+________________/RegistrationNumber
+________________/RepresentativeDetails
+__________________/Representative
+____________________/RepresentativeAddressBook
+______________________/FormattedNameAddress
+________________________/Address
+__________________________/AddressCountryCode
+__________________________/FreeFormatAddress
+____________________________/FreeFormatAddressLine
+________________________/Name
+__________________________/FreeFormatName
+____________________________/FreeFormatNameDetails
+______________________________/FreeFormatNameLine
+______________________________/FreeFormatNameLine[@languageCode=en]
+____________/RegistrationOfficeCode
+______/TransactionIdentifier
+______/TransactionSubCode

gbdtransformation/designs/bnid/template.yml

@@ -0,0 +1 @@
+{% include "ipas/template.yml" %}

gbdtransformation/designs/ipas/filters.py

@@ -0,0 +1,99 @@
+# standard gbd definitions
+from gbdtransformation.designs import kinds as std_kinds
+from gbdtransformation.designs import status as std_status
+from gbdtransformation.brands import events as std_events
+
+# namespaces defined in XML and to be ignored in procecssing
+ignore_namespace = []
+
+
+# -------------------------------------------------------------
+# data translation helpers:
+# translate values from office interpretation to gbd equivalent
+# -------------------------------------------------------------
+
+def translate_kind(kind):
+    """translation of the kind of trademark to a
+        multivalue gbd interpretation"""
+
+    # out-of-the-box match
+    if kind.capitalize() in std_kinds:
+        return [kind.capitalize()]
+
+    # __insert here__ : translation logic
+
+    # raise Exception to recognize unmapped values
+    raise Exception('kind "%s" is not mapped.' % kind)
+
+# Expired trademarks with no Expiry date
+# => get it from Expired event
+def get_expiry_date(design, idstatus):
+    if design.ExpiryDate:
+        return design.ExpiryDate
+
+    if not idstatus == 'Expired':
+        return None
+
+    # find the MarkEvent Expired and get its date
+    events = design.get('MarkEventDetails', {}).get('MarkEvent', [])
+    for event in events:
+        if hasattr(event, 'MarkEventCode'):
+            if(event.MarkEventCode == 'Expired'):
+                return event.MarkEventDate
+
+
+# Registered or Expired trademarks with no registration date
+# => get it from Registered or Published Event
+def get_registration_date(trademark, tmstatus):
+    if trademark.RegistrationDate:
+        return trademark.RegistrationDate
+
+    if not tmstatus in ['Expired', 'Registered']:
+        return None
+
+    # find the MarkEvent Expired and get its date
+    events = trademark.get('MarkEventDetails', {}).get('MarkEvent', [])
+
+    # first priority is to get the Registered Event
+    for event in events:
+        if hasattr(event, 'MarkEventCode'):
+            if event.MarkEventCode == 'Registered':
+                return event.MarkEventDate
+    # second priority is to get the Published Event
+    for event in events:
+        if hasattr(event, 'MarkEventCode'):
+            if event.MarkEventCode == 'Published':
+                return event.MarkEventDate
+
+def translate_status(status):
+    status = status.lower()
+
+    if status == 'registered': return 'Registered'
+    if status == 'active': return 'Registered'
+    if status == 'reinstated': return 'Registered'
+    if status == 'expired': return 'Expired'
+    if status == 'inactive': return 'Expired'
+    if status == 'published': return 'Pending'
+    if status == 'examined': return 'Pending'
+    if status == 'filed': return 'Pending'
+    if status == 'converted': return 'Pending'
+    if status == 'opposed': return 'Pending'
+    if status == 'pending': return 'Pending'
+    if status == 'appealed': return 'Pending'
+    if status == 'awaiting court action': return 'Pending'
+    if status == 'application published': return 'Pending'
+    if status == 'abandoned': return 'Ended'
+    if status == 'withdrawn': return 'Ended'
+    if status == 'rejected': return 'Ended'
+    if status == 'finalrefusal': return 'Ended'
+    if status == 'suspended': return 'Ended'
+    if status == 'invalidated': return 'Ended'
+    if status == 'surrendered': return 'Ended'
+    if status == 'suspended': return 'Ended'
+    if status == 'renewed': return 'Registered'
+    if status == 'renewalprocess': return 'Registered'
+    if status == 'canceled': return 'Ended'
+    if status == 'cancelled': return 'Ended'
+
+    #return 'Unknown'
+    raise Exception('Status "%s" not mapped.' % status)