wipo-gbd-transformation 1.1.53__py3-none-any.whl → 1.1.55__py3-none-any.whl

gbdtransformation/brands/chtm/template.yml

@@ -1,130 +1,121 @@
 {% from 'navigation.tmpl' import match %}
 
-{% call(info) match('marinfo', transac) %}
-{% set kind = info | get_kind %}
-type: TRADEMARK
-kind: {{ kind }}
-
-markFeature: {{ info.martype | translate_feature(info.marart) }}
+{% set trademark = Trademark %}
+{% set status = trademark.MarkCurrentStatusCode | translate_status %}
+{% set officeCode = trademark.RegistrationOfficeCode %}
 
-registrationOfficeCode: CH
-designatedCountries:
-  - CH
+{% if officeCode == 'CH' %}
 
-st13: {{ info.basappn | st13('CH', appdate=info.basannd) }}
+st13: {{ trademark.ApplicationNumber.ApplicationNumberText | st13('CH', appdate=trademark.ApplicationDate) }}
+gbdStatus: {{ status }}
+registrationOfficeCode: {{ officeCode }}
+type: TRADEMARK
 
-applicationNumber: {{ info.basappn }}
-applicationDate: {{ info.basannd }}
-registrationNumber: {{ info.basregn }}
-registrationDate: {{ info.basregd }}
+{% if not status == 'Delete' %}
+kind: {{ tradenark.MarkCategory | translate_kind }}
+markFeature: {{ trademark.MarkRepresentation.MarkFeatureCategory | translate_feature }}
+designatedCountries: 
+  - {{ officeCode }}
 
-applicationLanguageCode: {{ info.origlan }}
+applicationNumber: {{ trademark.ApplicationNumber.ApplicationNumberText }}
+applicationDate: {{ trademark.ApplicationDate | convertdate('%Y-%m-%d') }}
+registrationNumber: {{ trademark | get_registration_nb(trademark.MarkCurrentStatusCode) }}
+registrationDate: {{ trademark.RegistrationDate }}
+applicationLanguageCode: 
+officeStatus: {{ trademark.MarkCurrentStatusCode }}
+statusDate: 
+expiryDate: {{ trademark.ExpiryDate }}
 
-expiryDate: {{ info.expirationdate }}
-terminationDate: {{ info.basdeld }}
+markDisclaimerDetails: 
 
-officeStatus: {{ info.basstate }}
-gbdStatus: {{ info.basstate | translate_status(info.basdeld) }}
-statusDate: {{ info.lastgazd }}
+markDescriptionDetails:
 
-markDisclaimerDetails:
-  - languageCode: {{ info.marrem | guess_language(info.origlan) }}
-    text: {{ info.marrem }}
+wordMarkSpecification:
+  markVerbalElement:
+    {% set verbalElement = trademark.MarkRepresentation.MarkReproduction.WordMarkSpecification.MarkSignificantVerbalElementText | clean_verbal_element %}
+    - text: {{ verbalElement }}
+      languageCode: 
 
 markImageDetails:
-  - name: {{ info.marpicd }}
-    colourIndicator: {{ info.colclai | get_true_or_false }}
+  {% call(img) match('MarkImage', trademark.MarkRepresentation.MarkImageBag) %}
+  - name: {{ img.FileName }}
+    colourIndicator: {{ img.MarkImageColourClaimedText | get_true_or_false }}
     colourClaimed:
-      - languageCode: {{ info.colclai | guess_language }}
-        text: {{ info.colclai }}
-
-{% set verbal = info | get_verbal %}
-wordMarkSpecification:
-  markVerbalElement:
-    - languageCode: {{ verbal | guess_language(default=info.origlan) }}
-      text: {{ verbal | trim }}
+      - text: {{ img.MarkImageColourClaimedText }}
+        languageCode: {{ img.MarkImageColourClaimedText | local_guess_language() }}
+    classification:
+      kind: Vienna
+      code:
+      - 
+  {% endcall %}
 
-{% set persons = info | get_roles %}
-applicants:
-{% for applicant in persons.applicants %}
-  - fullName:
-      - languageCode: {{ info.origlan }}
-        text: {{ applicant.name }}
-    fullAddress:
-      - languageCode: {{ info.origlan }}
-        text: {{ applicant.addr  }}
-    countryCode: {{ applicant.nat }}
-{% endfor %}
+markSoundDetails:
+  {% call(sound) match('MarkSoundDetails.MarkSound', trademark.MarkRepresentation.MarkSoundBag) %}
+  - filename: {{ sound.MarkSoundFilename }}
+    fileformat: {{ sound.MarkSoundFileFormat }}
+  {% endcall %}
 
-representatives:
-{% for representative in persons.representatives %}
-  - fullName:
-      - languageCode: {{ info.origlan }}
-        text: {{ representative.name }}
-    fullAddress:
-      - languageCode: {{ info.origlan }}
-        text: {{ representative.addr }}
-    countryCode: {{ representative.nat }}
-{% endfor %}
-
-{% if persons.correspondence %}
-correspondence:
-  fullName:
-    - languageCode: {{ info.origlan }}
-      text: {{ persons.correspondence.name }}
-  fullAddress:
-    - languageCode: {{ info.origlan }}
-      text: {{ persons.correspondence.addr }}
-  countryCode: {{ persons.correspondence.nat }}
-{% endif %}
+markVideoDetails:
+  {% call(video) match('MarkVideoDetails.MarkVideo', trademark.MarkRepresentation) %}
+  - filename: {{ video.MarkVideoFilename }}
+    fileformat: {{ video.MarkVideoFileFormat }}
+  {% endcall %}
 
-priorities:
-{% call(prio) match('prigr.prio', info) %}
-  - countryCode: {{ prio.prinat }}
-    number: {{ prio.prinr }}
-    date: {{ prio.priappd }}
-    comment: {{ prigr.prirem }}
-{% endcall %}
-
-{% set (nc_gs, gs) = info.gsgr | structure_gs %}
-{% if nc_gs.keys() | length > 0 %}
 goodsServicesClassification:
   kind: Nice
   version: {{ ASK_THE_OFFICE }}
-  class:
-    {% for cls, terms in nc_gs.items() %}
-    - code: {{ cls | int }}
-      {% if terms | length > 0 %}
-      terms:
-        {{ terms | guess_language(default=info.origlan) | field_name }}:
-          {% for term in terms %}
-          - {{ term }}
-          {% endfor %}
-      {% endif %}
-    {% endfor %}
-{% endif %}
+  class: 
+     {% call(ClassDescription) match('ClassDescription', trademark.GoodsServicesBag.GoodsServices.ClassDescriptionBag) %}
+    - code: {{ ClassDescription.ClassNumber }}
+      terms: {{ ClassDescription.GoodsServicesDescriptionText }}
+      languageCode: {{ ClassDescription.GoodsServicesDescriptionText | local_guess_language() }}
+     {% endcall %}
 
-{% if gs | length > 0 %}
-goodsServicesUnclassified:
-  {{ gs | guess_language(default=info.origlan) | field_name }}:
-    {% for term in gs %}
-    - {{ term }}
-    {% endfor %}
-{% endif %}
+priorities:
+  {% call(priority) match('PriorityBag.Priority', trademark) %}
+  - countryCode: {{ priority.PriorityCountryCode }}
+    number: {{ priority.PriorityRegistrationNumber }}
+    date: {{ select_priority_date }}
+  {% endcall %}
+
+publications:
+  {% call(publication) match('PublicationBag.Publication', trademark) %}
+  - identifier: {{ publication.PublicationIdentifier }}
+    date: {{ publication.PublicationDate }}
+    section: {{ publication.PublicationPage }}
+  {% endcall %}
 
-# publications:
-# {% call(publ) match('marhist.histdata', transac) %}
-#   - identifier: {{ publ.artnr }}
-#     date: {{ publ.evdat }}
-#     section: {{ publ.gaznum }}
-# {% endcall %}
-
-extra:
-  {% call(opp) match('oppositiongr', info) %}
-  opposition:
-    state: {{ opp.oppositionstate }}
-    date: {{ opp.oppositiondate }}
+applicants:
+  {% call(Applicant) match('Applicant', trademark.ApplicantBag) %}
+  - identifier: 
+    kind: 
+    fullName:
+      - text: {{ Applicant.Contact.Name.PersonName.PersonFullName }}
+        languageCode: 
+    {% call(postalAddress) match('PostalAddress', Applicant.Contact.PostalAddressBag) %}
+    fullAddress:
+      {% set addr = postalAddress.PostalStructuredAddress | get_full_address %}
+      - text: {{ addr }} 
+        languageCode: {{ addr | local_guess_language() }}
+    countryCode: {{ postalAddress.PostalStructuredAddress.CountryCode }}
+    {% endcall %}
   {% endcall %}
 
-{% endcall %}
+representatives:
+  {% call(Representative) match('Representative', trademark.RepresentativeBag) %}
+  - identifier: 
+    kind: 
+    fullName:
+      - text: {{ Representative.Contact.Name.PersonName.PersonFullName }}
+        languageCode: 
+    {% call(postalAddress) match('PostalAddress', Representative.Contact.PostalAddressBag) %}
+    fullAddress:
+      {% set addr = postalAddress.PostalStructuredAddress | get_full_address %}
+      - text: {{ addr }} 
+        languageCode: {{ addr | local_guess_language() }} 
+    countryCode: {{ postalAddress.PostalStructuredAddress.CountryCode }}
+    {% endcall %}
+  {% endcall %}
 
+{% endif %}
+{% endif %}

gbdtransformation/brands/natm/__init__.py

@@ -6,7 +6,6 @@ source = 'national'
 # NA/T/197/593
 # AP/M/2006/413
 # A/D/1/825028
-appnum_mask = [ '[A-Z]{2}/([A-Z])/\\d{4}/(\\d*)',
-                '[A-Z]{2}/([A-Z])/\\d{3}/(\\d*)',
-                '([A-Z])/D/1/(\\d*)' ]
+appnum_mask = [ '([A-Z]{2})/([A-Z])/\\d*/(\\d*)',
+                '([A-Z])/[A-Z]/1/(\\d*)' ]
 

gbdtransformation/brands/natm/filters.py

@@ -11,27 +11,33 @@ def translate_type(header):
     code = header.TransactionCode
 
     # extraction missing info.
-    if code == 'Do Not Use':
+    if 'do not use' in code.lower():
         raise Exception('Code "%s" encountered. Skipping.' % code)
 
     if code == 'National Trademarks': return 'TRADEMARK'
+    if code == 'National Marks Act 2012': return 'TRADEMARK'
     if code == 'Madrid Marks': return 'TRADEMARK'
     if code == 'Banjul Trademark': return 'TRADEMARK'
+    if code == 'Banjul Protocol Marks': return 'TRADEMARK'
     if code == 'DEFENSIVE MARK': return 'TRADEMARK'
+    if code == 'CERTIFICATION MARK': return 'TRADEMARK'
 
     raise Exception('Type "%s" is not mapped.' % code)
 
 def translate_kind(trademark, header):
     subcode = header.TransactionSubCode
 
+    if subcode == 'Trade Mark': return ['Individual']
     if subcode == 'PART A': return ['Individual']
     if subcode == 'PART B': return ['Individual']
     if subcode == 'Banjul Trademark': return ['Individual']
+    if subcode == 'Banjul Protocol Marks': return ['Individual']
     if subcode == 'Madrid Protocol': return ['Individual']
     if subcode == 'Madrid Agreement': return ['Individual']
     if subcode == 'DEFENSIVE MARK': return ['Defensive']
+    if subcode == 'CERTIFICATION MARK': return ['Collective']
 
-    raise Exception('Kind "%s" not mapped.' % code)
+    raise Exception('Kind "%s" not mapped.' % subcode)
 
 def translate_status(trademark):
     status = trademark.MarkCurrentStatusCode

gbdtransformation/brands/notm/__init__.py

@@ -0,0 +1,5 @@
+# instruction to render the output to JSON format
+render = 'JSON'
+source = 'national'
+
+

gbdtransformation/brands/notm/filters.py

@@ -0,0 +1,117 @@
+import re
+
+def translate_kind(kind):
+    if not kind: return ['Individual']
+
+    if kind == 'Individual mark': return ['Individual']
+    if kind == 'Collective mark': return ['Collective']
+
+    raise Exception('kind "%s" is not mapped.' % kind)
+
+def translate_status(status):
+    if not status: return 'Ended'
+
+    if status in ['Registered',
+                  'Granted']: 
+        return 'Registered'
+
+    if status in ['Pending']:
+        return 'Pending'
+
+    if status in ['Refused',
+                  'Shelved',
+                  'Finally shelved',
+                  'Ceased',
+                  'Ceased/cancelled',
+                  'Withdrawn']:
+        return 'Ended'
+
+    #return 'Unknown'
+    raise Exception('Status "%s" unmapped' % status)
+
+def translate_feature(feature):
+    """translation of mark feature"""
+    if not feature: return 'Undefined'
+    feature = feature.upper()
+    if feature == 'COMBINED/FIGURATIVE MARK': return 'Combined'
+    if feature == 'WORD MARK': return 'Word'
+    if feature == '3D-MARK': return "Three dimensional"
+
+    #return 'Unknown'
+
+    # raise Exception to recognize unmapped values
+    raise Exception('Feature "%s" unmapped' % feature)
+
+def get_local_text(node):
+    if "$" in node:
+        return node["$"]
+
+def get_local_texts(nodes):
+    text = ""
+    start = True
+    for node in nodes:
+        if "$" in node:
+            if start:
+                start = False
+            else:
+                text += ", "
+            text += node["$"]
+    return text
+
+"""
+def get_registration_nb(trademark, tmstatus):
+    if trademark.RegistrationNumber:
+        return trademark.RegistrationNumber
+
+    # default registration number to application number
+    # in case none is provided
+    if tmstatus in ['Registered', 'Expired']:
+        return trademark.ApplicationNumber.ApplicationNumberText
+"""
+
+def get_full_address(postalStructuredAddress):
+    result = ""
+    if "addressLineText" in postalStructuredAddress:
+        for addressLineText in postalStructuredAddress["addressLineText"]:
+            """
+            if hasattr(addressLineText, '__value'):
+                if len(result) > 0:
+                    result += ", "
+                result += addressLineText.__value
+            """
+    if "cityName" in postalStructuredAddress:
+        if len(result) > 0:
+            result += ", "
+        result += postalStructuredAddress["cityName"]
+    if "countryCode" in postalStructuredAddress:
+        result += ", " + postalStructuredAddress["countryCode"]
+    if "postalCode" in postalStructuredAddress:
+        result += " " + postalStructuredAddress["postalCode"]
+    if len(result) == 0:
+        return
+    else: 
+        return result.strip()
+
+"""
+def select_priority_date(priority):
+    if priority == None:
+        return None
+    if "PriorityApplicationFilingDate" in priority:
+        return priority["PriorityApplicationFilingDate"]
+    elif "PriorityRegistrationDate" in priority:
+        return priority["PriorityRegistrationDate"]
+    else:
+        return None
+
+def clean_verbal_element(element_text):
+    if element_text == None:
+        return None
+    element_text = element_text.replace("((fig.))", "")
+    return element_text.strip()
+"""
+
+def local_guess_language(content):    
+    if content == None:
+        return None
+    from langdetect import detect
+    return detect(content)

gbdtransformation/brands/notm/template.yml

@@ -0,0 +1,165 @@
+{% from 'navigation.tmpl' import match %}
+{% from 'navigation.tmpl' import enumerate %}
+
+{% call(trademark) match('trademark', trademarkBag) %}
+
+{% call(applicationNumber) match('applicationNumber', trademark.trademarkTypeChoice1) %}
+st13: {{ applicationNumber.applicationNumberText | st13('NO', appdate=trademark.trademarkTypeChoice2.applicationDate) }}
+applicationNumber: {{ applicationNumber.applicationNumberText }}
+{% endcall %}
+applicationDate: {{ trademark.trademarkTypeChoice2.applicationDate | convertdate('%Y-%m-%d') }}
+
+registrationNumber: {{ trademark.trademarkTypeChoice1.registrationNumber }}
+registrationDate: {{ trademark.registrationDate }}
+
+expiryDate: {{ trademark.expiryDate }}
+# rarely passed
+terminationDate:
+
+{% set status = trademark.markCurrentStatusCode | translate_status %}
+gbdStatus: {{ status }}
+officeStatus: {{ trademark.markCurrentStatusCode }}
+statusDate: {{ trademark.markCurrentStatusDate }}
+
+registrationOfficeCode: "NO"
+designatedCountries:
+  - "NO"
+
+type: TRADEMARK
+
+kind:
+  - Individual
+
+markFeature: {{ trademark.markFeatureDescription | translate_feature() }}
+# (Word|Stylized characters|Figurative|Combined|Three dimensional|Colour|Sound|Hologram|Olfactory|Motion|Municipal|Chimney|Other|Undefined)
+
+kind:
+  - Individual
+  # (Individual|Collective|Certificate|Defensive|Other|Membership)
+
+publicationDate: #
+
+applicationLanguageCode:
+# rarely passed
+secondLanguageCode:
+
+markDisclaimerDetails:
+  {% call(markDisclaimerText) match('markDisclaimerText', trademark.markDisclaimerBag) %}
+  - languageCode: 
+    text: {{ markDisclaimerText | get_local_text() }}
+  {% endcall %}
+
+markDescriptionDetails:
+  - languageCode:
+    text: 
+
+wordMarkSpecification:
+  markVerbalElement:
+    - languageCode:
+      text: {{ trademark.markRepresentation.markReproduction.wordMarkSpecification.markVerbalElementText | get_local_text() }}
+  markSignificantVerbalElement:
+    - languageCode:
+      text: {{ trademark.markRepresentation.markReproduction.wordMarkSpecification.markSignificantVerbalElementText | get_local_text() }}
+  markTranslation:
+    - languageCode:
+      text:
+  markTransliteration:
+
+markImageDetails:
+  {% call(markImage) match('markImage', trademark.markRepresentation.markReproduction.markImageBag) %}
+  - name:  {{ markImage.fileName }}
+    colourIndicator: {{ markImage.colourModeCategory }}
+    colourClaimed:
+      - languageCode:
+        text:
+    description:
+      {% call(markDescriptionText) match('markDescriptionText', trademark.markRepresentation.markDescriptionBag.markDescriptionBagTypeChoiceSequence) %}
+      - languageCode:
+        text: {{ markDescriptionText | get_local_text() }}
+      {% endcall %}
+    classification:
+      kind: 
+      version:  
+      code:
+        - 
+  {% endcall %}
+
+markSoundDetails:
+  - filename:
+    fileformat:
+
+markVideoDetails:
+  - filename:
+    fileformat:
+
+goodsServicesClassification:
+  kind: Nice 
+  version:
+  class:
+    {% call(goodsServices) match('goodsServices', trademark.goodsServicesBag) %}
+    {% call(classDescription) match('classDescription', goodsServices.classDescriptionBag) %}
+    - code: {{ classDescription.classNumber }}
+      terms:
+        {% call(goodsServicesDescriptionText) match('goodsServicesDescriptionText', classDescription) %}
+        {{ goodsServicesDescriptionText.localizedTextType | get_local_text | local_guess_language() }}:
+          - {{ goodsServicesDescriptionText.localizedTextType | get_local_text }}
+        {% endcall %}  
+    {% endcall %}
+    {% endcall %}
+
+priorities:
+  {% call(priority) match('priority', trademark.priorityBag) %}
+  - countryCode: {{  priority.priorityCountryCode }}
+    number: {{ priority.applicationNumber.applicationNumberText }}
+    date: {{ priority.priorityApplicationFilingDate }}
+    comment:
+  {% endcall %}
+
+publications:
+  - identifier:
+    date:
+    section:
+
+representatives:
+  {% call(representative) match('representative', trademark.representativeBag) %}
+  - identifier: {{ representative.partyIdentifier }}
+    kind:
+    fullName:
+      - languageCode:
+        text: {{ representative.contact.contactTypeChoiceSequence.name.entityName.transliterationName | get_local_texts() }}
+    fullAddress:
+      {% call(postalAddress) match('postalAddress', representative.contact.contactTypeChoiceSequence.postalAddressBag) %}
+      - languageCode:
+        text: {{ postalAddress.postalStructuredAddress | get_full_address() }}
+      {% endcall %}
+    countryCode:
+  {% endcall %}
+
+correspondence:
+  fullName:
+    - languageCode:
+      text:
+  fullAddress:
+    - languageCode:
+      text:
+  countryCode:
+
+applicants:
+  {% call(applicant) match('applicant', trademark.applicantBag) %}
+  - identifier: {{ applicant.partyIdentifier }}
+    kind:
+    fullName:
+      - languageCode:
+        text: {{ applicant.contact.contactTypeChoiceSequence.name.entityName.transliterationName | get_local_texts() }}
+    fullAddress:
+      {% call(postalAddress) match('postalAddress', applicant.contact.contactTypeChoiceSequence.postalAddressBag) %}
+      - languageCode: 
+        text: {{ postalAddress.postalStructuredAddress | get_full_address() }}
+      {% endcall %}
+    countryCode: 
+  {% endcall %}
+
+{% endcall %}
+
+# here goes extra information that is office specific and that is pertinent for us to retain.
+extra: