wipo-gbd-transformation 1.1.105__py3-none-any.whl

gbdtransformation/brands/phtm/schema

@@ -0,0 +1,79 @@
+/Transaction
+__/TradeMarkTransactionBody
+____/TransactionContentDetails
+______/TransactionCode
+______/TransactionData
+________/TradeMarkApplication
+__________/TradeMarkDetails
+____________/TradeMark
+______________/ApplicantDetails
+________________/Applicant
+__________________/ApplicantAddressBook
+____________________/FormattedNameAddress
+______________________/Address
+________________________/AddressCountryCode
+______________________/Name
+________________________/FreeFormatName
+__________________________/FreeFormatNameDetails
+____________________________/FreeFormatNameLine
+____________________________/FreeFormatNameLine[@languageCode=en]
+______________/ApplicationDate
+______________/ApplicationLanguageCode
+______________/ApplicationNumber
+______________/ExpiryDate
+______________/GoodsServicesDetails
+________________/GoodsServices
+__________________/ClassDescriptionDetails
+____________________/ClassDescription
+______________________/ClassNumber
+______________________/GoodsServicesDescription
+______________________/GoodsServicesDescription[@languageCode=en]
+______________/MarkCurrentStatusCode
+______________/MarkCurrentStatusDate
+______________/MarkDisclaimerDetails
+________________/MarkDisclaimer
+________________/MarkDisclaimer[@languageCode=en]
+______________/MarkEventDetails
+________________/MarkEvent
+__________________/MarkEventCode
+__________________/MarkEventDate
+__________________/OfficeSpecificMarkEventName
+______________/MarkFeature
+______________/MarkImageDetails
+________________/MarkImage
+__________________/MarkImageCategory
+____________________/CategoryCodeDetails
+______________________/CategoryCode
+____________________/CategoryKind
+____________________/CategoryVersion
+__________________/MarkImageFileFormat
+__________________/MarkImageFilename
+______________/PriorityDetails
+________________/Priority
+__________________/PriorityCountryCode
+__________________/PriorityDate
+__________________/PriorityNumber
+______________/PublicationDetails
+________________/Publication
+__________________/PublicationDate
+__________________/PublicationIdentifier
+__________________/PublicationSection
+______________/RegistrationDate
+______________/RegistrationNumber
+______________/RegistrationOfficeCode
+______________/RepresentativeDetails
+________________/Representative
+__________________/RepresentativeAddressBook
+____________________/FormattedNameAddress
+______________________/Address
+________________________/AddressCountryCode
+______________________/Name
+________________________/FreeFormatName
+__________________________/FreeFormatNameDetails
+____________________________/FreeFormatNameLine
+____________________________/FreeFormatNameLine[@languageCode=en]
+______________/WordMarkSpecification
+________________/MarkVerbalElementText
+________________/MarkVerbalElementText[@languageCode=en]
+______/TransactionIdentifier
+______/TransactionSubCode

gbdtransformation/brands/phtm/schema.classic

@@ -0,0 +1,50 @@
+/RECORD
+__/AGENT
+____/ADDR_STREET
+____/AGENT_CODE
+____/CITY_NAME
+____/PERSON_NAME
+____/PROVINCE_NAME
+__/APPL_SUBTYP
+__/APPL_TYP
+__/APPNO
+__/EXPIRATION_DATE
+__/FILE_NBR
+__/FILE_SEQ
+__/FILE_SER
+__/FILE_TYP
+__/FILING_DATE
+__/LAW_CODE
+__/LOGO
+____/LOGO
+__/NICE_CLASS
+____/NICE_CLASS_CODE
+____/NICE_CLASS_DESCRIPTION
+__/OWNER
+____/ADDR_STREET
+____/CITY_NAME
+____/NATIONALITY_COUNTRY_CODE
+____/PERSON_NAME
+____/PROVINCE_NAME
+____/RESIDENCE_COUNTRY_CODE
+____/STATE_CODE
+____/STATE_NAME
+__/PRIORITIES
+____/COUNTRY_CODE
+____/PRIORITY_APPL_ID
+____/PRIORITY_DATE
+__/PUBLICATION_DATE
+__/REGISTRATION_DATE
+__/REGISTRATION_NBR
+__/SIGN_TYPE
+__/STATUS_CATEGORY
+__/STATUS_DATE
+__/STATUS_NAME
+__/TITLE
+__/VIENNA
+____/VIENNA_CLASS_CODE
+____/VIENNA_ELEM_CODE
+____/VIENNA_GROUP_CODE
+____/VIENNA_NAME
+____/VIENNA_TEXT
+__/sign_type

gbdtransformation/brands/phtm/template.classic.yml

@@ -0,0 +1,102 @@
+{% from 'navigation.tmpl' import match %}
+{% set status = RECORD | translate_status %}
+
+type: TRADEMARK
+kind:
+  - Individual
+
+st13: {{ RECORD.APPNO | st13('PH') }}
+
+markFeature: {{ RECORD.SIGN_TYPE | translate_feature}}
+registrationOfficeCode: PH
+designatedCountries:
+  - PH
+
+applicationNumber: {{ RECORD.APPNO }}
+applicationDate: {{ RECORD.FILING_DATE | convertdate('%Y-%m-%dT%H:%M:%S')}}
+registrationNumber: {{ RECORD.REGISTRATION_NBR }}
+registrationDate: {{ RECORD.REGISTRATION_DATE | convertdate('%Y-%m-%dT%H:%M:%S')}}
+
+reference:
+{% if RECORD.APPL_TYP == 'M' %}
+  office: WO
+  registration:
+    - number: {{ RECORD.FILE_NBR }}
+{% endif %}
+
+applicationLanguageCode: en
+expiryDate: {{ RECORD.EXPIRATION_DATE | convertdate('%Y-%m-%dT%H:%M:%S')}}
+{% if status == 'Ended' %}
+terminationDate: {{ RECORD.EXPIRATION_DATE | convertdate('%Y-%m-%dT%H:%M:%S')}}
+{% endif %}
+
+officeStatus: {{ RECORD.STATUS_NAME }}
+gbdStatus: {{ status }}
+statusDate: {{ RECORD.STATUS_DATE | convertdate2('%m/%d/%Y;%b\t%d\t%Y')}}
+
+{% if RECORD.TITLE %}
+wordMarkSpecification:
+  markVerbalElement:
+  - languageCode: en
+    text: {{ RECORD.TITLE}}
+{% endif %}
+
+{% if RECORD.SIGN_TYPE == 'B' or RECORD.SIGN_TYPE == 'L' %}
+markImageDetails:
+  - name: {{ RECORD.LOGO.LOGO }}
+    {% if RECORD.VIENNA %}
+    classification:
+      kind: Vienna
+      code:
+      {% call(vienna) match('VIENNA', RECORD) %}
+      - {{ vienna.VIENNA_TEXT | pad_vienna }}
+      {% endcall %}
+    {% endif %}
+{% endif %}
+
+{% if RECORD.NICE_CLASS %}
+goodsServicesClassification:
+  kind: Nice
+  version: {{ ASK_THE_OFFICE }}
+  class:
+  {% call(nice) match('NICE_CLASS', RECORD) %}
+    - code: {{ nice.NICE_CLASS_CODE | int }}
+      terms:
+        en:
+          {% for gsline in nice.NICE_CLASS_DESCRIPTION | split_terms %}
+          - {{ gsline | remove_trailing('.') | lower }}
+          {% endfor %}
+  {% endcall %}
+{% endif %}
+
+priorities:
+  {% call(priority) match('PRIORITIES', RECORD) %}
+    - countryCode: {{ priority.COUNTRY_CODE }}
+      number: {{ priority.PRIORITY_APPL_ID | remove_trailing('-') }}
+      date: {{ priority.PRIORITY_DATE  | convertdate('%Y-%m-%dT%H:%M:%S')}}
+  {% endcall %}
+
+applicants:
+  {% call(applicant) match('OWNER', RECORD) %}
+      - fullName:
+          - text: {{ applicant.PERSON_NAME }}
+            languageCode: en
+        countryCode: {{ applicant.RESIDENCE_COUNTRY_CODE | remove_trailing('-', '.') }}
+        fullAddress:
+          - text: {{ applicant | get_address }}
+            languageCode: en
+  {% endcall %}
+
+representatives:
+  {% call(rep) match('AGENT', RECORD) %}
+  {% if rep.PERSON_NAME %}
+  - identifier: {{ rep.AGENT_CODE }}
+    fullName:
+    - text: {{ rep.PERSON_NAME }}
+      languageCode: en
+    countryCode: PH
+    fullAddress:
+    - text: {{ rep | get_address }}
+      languageCode: en
+  {% endif %}
+  {% endcall %}

gbdtransformation/brands/phtm/template.yml

@@ -0,0 +1,189 @@
+{% from 'navigation.tmpl' import match %}
+
+{% call(header) match('TradeMarkTransactionBody.TransactionContentDetails', Transaction) %}
+
+{% set type = header | translate_type %}
+type: {{ type }}
+
+{% call(trademark) match('TransactionData.TradeMarkApplication.TradeMarkDetails.TradeMark', header) %}
+
+{% set kind = trademark | translate_kind(header) %}
+
+kind: {{ kind }}
+
+reference:
+{% if header | is_international %}
+  office: WO
+  registration:
+    - number: {{ trademark.ApplicationNumber | get_ir_refnum }}
+{% endif %}
+{% if not type == 'TRADEMARK' %}
+  office: {{ trademark.RegistrationOfficeCode }}
+{% endif %}
+
+registrationOfficeCode: {{ trademark.RegistrationOfficeCode }}
+designatedCountries:
+  - {{ trademark.RegistrationOfficeCode }}
+
+applicationLanguageCode: {{ trademark.ApplicationLanguageCode }}
+
+{% set tmstatus = trademark | translate_status %}
+{% set appdate = trademark.ApplicationDate %}
+
+
+gbdStatus: {{ tmstatus }}
+officeStatus: {{ trademark.MarkCurrentStatusCode | parseStatus }}
+statusDate: {{ trademark.MarkCurrentStatusDate }}
+publicationDate: {{ (trademark.PublicationDetails.Publication | last).PublicationDate }}
+
+markFeature: {{ trademark | translate_feature }}
+
+st13: {{ trademark.ApplicationNumber | st13(trademark.RegistrationOfficeCode, type=type, appdate=appdate) }}
+applicationNumber: {{ trademark.ApplicationNumber }}
+applicationDate: {{ trademark.ApplicationDate }}
+registrationNumber: {{ trademark | get_registration_nb(tmstatus) | remove_trailing('-') }}
+registrationDate: {{ trademark | get_registration_date(tmstatus) }}
+
+expiryDate: {{ trademark | get_expiry_date(tmstatus) }}
+
+{% if tmstatus == 'Ended' %}
+terminationDate: {{ trademark.MarkCurrentStatusDate }}
+{% endif %}
+
+markDisclaimerDetails:
+  {% call(disclaimer) match('MarkDisclaimerDetails.MarkDisclaimer', trademark) %}
+  {% if disclaimer.__value != 'N/A' and disclaimer.__value != 'NONE' and disclaimer.__value != 'None' %}
+  - text: {{ disclaimer.__value }}
+    languageCode: {{ disclaimer.__value | guess_language(disclaimer._languageCode, default=trademark.ApplicationLanguageCode) }}
+  {% endif %}
+  {% endcall %}
+
+wordMarkSpecification:
+  {% call(wordSpec) match('WordMarkSpecification', trademark) %}
+  {% set verbal_by_language = wordSpec.MarkVerbalElementText | verbal_lang_map(applang=trademark.ApplicationLanguageCode) %}
+  markVerbalElement:
+    {% for lang, verbals in verbal_by_language.items() %}
+    {% for verbal in verbals %}
+    - languageCode: {{ lang }}
+      text: {{ verbal }}
+    {% endfor %}
+    {% endfor %}
+  markTranslation:
+    {% call(trans) match('MarkTranslation', wordSpec) %}
+    {% if trans != 'N/A' and trans != 'NONE' and trans != 'None' %}
+    - text: {{ trans }}
+      languageCode: {{ trans | guess_language(trans._languageCode, trademark.ApplicationLanguageCode) }}
+    {% endif %}
+    {% endcall %}
+  {% endcall %}
+
+markImageDetails:
+  {% call(img) match('MarkImageDetails.MarkImage', trademark) %}
+    - name: {{ img | get_file_name }}
+      {% call(cclaim) match('MarkImageColourClaimedText', img) %}
+      {% if cclaim.__value  != 'N/A' and cclaim.__value  != 'NONE' and cclaim.__value  != 'None' %}
+      colourIndicator: {{ cclaim.__value | remove_trailing('-') | get_true_or_false }}
+      colourClaimed:
+        - text: {{ cclaim.__value | remove_trailing('-') }}
+          languageCode: {{  cclaim.__value | remove_trailing('-') | guess_language(cclaim._languageCode, trademark.ApplicationLanguageCode) }}
+      {% endif %}
+      {% endcall %}
+      {% call(category) match('MarkImageCategory', img) %}
+      classification:
+        kind: {{ category.CategoryKind }}
+        version: {{ category.CategoryVersion | parse_version }}
+        code:
+          {% call(vc) match('CategoryCodeDetails.CategoryCode', category) %}
+            - {{ vc }}
+          {% endcall %}
+      {% endcall %}
+  {% endcall %}
+
+{% set nc_gs = trademark.GoodsServicesDetails.GoodsServices.ClassDescriptionDetails.ClassDescription | get_goods_services %}
+{% if (nc_gs.keys() | length) > 0 %}
+goodsServicesClassification:
+  kind: Nice
+  version: {{ ASK_THE_OFFICE }}
+  class:
+    {% for nc in nc_gs.keys() %}
+    - code: {{ nc | int }}
+      {% if nc_gs[nc]['terms'] %}
+      terms:
+        {{ nc_gs[nc]['terms'] | guess_language(nc_gs[nc['terms']], trademark.ApplicationLanguageCode) | field_name}}:
+        {% for gsline in nc_gs[nc]['terms'] | remove_trailing('.', '-') | split_terms %}
+          - {{ gsline | lower }}
+        {% endfor %}
+      {% endif %}
+    {% endfor %}
+{% endif %}
+
+
+applicants:
+  {% call(applicant) match('ApplicantDetails.Applicant', trademark) %}
+    {% call(details) match('ApplicantAddressBook.FormattedNameAddress.Name.FreeFormatName', applicant) %}
+      - identifier: {{ details.ApplicantIdentifier }}
+        fullName:
+          {% call(nameline) match('FreeFormatNameDetails.FreeFormatNameLine', details) %}
+          {% if nameline | has_value %}
+          - text: {{ nameline }}
+            languageCode: {{ nameline.__value | guess_language(nameline._languageCode, trademark.ApplicationLanguageCode) }}
+          {% endif %}
+          {% endcall %}
+      {% endcall %}
+      {% call(address) match('ApplicantAddressBook.FormattedNameAddress.Address', applicant) %}
+        fullAddress:
+          {% call(adrline) match('FreeFormatAddress.FreeFormatAddressLine', address) %}
+          {% if adrline | has_value %}
+          - text: {{ adrline }}
+            languageCode: {{ adrline | guess_language(adrline._languageCode, trademark.ApplicationLanguageCode) }}
+          {% endif %}
+          {% endcall %}
+        countryCode: {{ address.AddressCountryCode | remove_trailing('-', '.') | remove_numerics }}
+      {% endcall %}
+    {% endcall %}
+
+representatives:
+  {% call(representative) match('RepresentativeDetails.Representative', trademark) %}
+    {% call(details) match('RepresentativeAddressBook.FormattedNameAddress.Name.FreeFormatName', representative) %}
+      - identifier: {{ details.RepresentativeIdentifier }}
+        fullName:
+          {% call(nameline) match('FreeFormatNameDetails.FreeFormatNameLine', details) %}
+          - text: {{ nameline }}
+            languageCode: {{ nameline.__value | guess_language(nameline._languageCode, trademark.ApplicationLanguageCode) }}
+          {% endcall %}
+      {% endcall %}
+      {% call(address) match('RepresentativeAddressBook.FormattedNameAddress.Address', representative) %}
+        fullAddress:
+          {% call(adrline) match('FreeFormatAddress.FreeFormatAddressLine', address) %}
+          {% if not adrline == '-' %}
+          - text: {{ adrline }}
+            languageCode: {{ adrline | guess_language(adrline._languageCode, trademark.ApplicationLanguageCode) }}
+          {% endif %}
+          {% endcall %}
+        countryCode: {{ address.AddressCountryCode | remove_trailing('-', '.') | remove_numerics }}
+      {% endcall %}
+    {% endcall %}
+
+priorities:
+  {% call(priority) match('PriorityDetails.Priority', trademark) %}
+    - countryCode: {{ priority.PriorityCountryCode }}
+      number: {{ priority.PriorityNumber }}
+      date: {{ priority.PriorityDate }}
+  {% endcall %}
+
+events:
+  {% call(event) match('MarkEventDetails.MarkEvent', trademark) %}
+  {% if event.MarkEventCode %}
+    - officeKind: {{ event.MarkEventCode }}
+      gbdKind: {{ event.MarkEventCode | translate_event }}
+      date: {{ event.MarkEventDate }}
+  {% else %}
+    - officeKind: {{ event.OfficeSpecificMarkEventName }}
+      gbdKind: {{ event.OfficeSpecificMarkEventName | translate_event }}
+      date: {{ event.MarkEventDate }}
+    
+  {% endif %}
+  {% endcall %}
+
+{% endcall %}
+{% endcall %}

gbdtransformation/brands/pytm/__init__.py

@@ -0,0 +1,6 @@
+# instruction to render the output to JSON format
+render = 'JSON'
+source = 'national'
+
+appnum_mask = [ "PY/M/(\\d{4})/(\\d*)", "PY/M/\\d{4}/(\\d*)" ]
+regnum_mask = [ "(\\d{4})/(\\d*)", "\\d{4}/(\\d*)"]

gbdtransformation/brands/pytm/filters.py

@@ -0,0 +1,136 @@
+import gbdtransformation.brands.ipas.filters as ipas
+
+ignore_namespace = [
+   'http://www.wipo.int/standards/XMLSchema/trademarks',
+   'http://www.wipo.int/standards/XMLSchema/wo-trademarks']
+
+def get_appdate(appdate, appnum):
+    return appnum.split('/')[-2].zfill(4)
+
+def translate_type(header):
+    code = header.TransactionCode
+    subcode = header.TransactionSubCode
+
+    if subcode == 'Denominación de Origen': return 'AO'
+    if subcode == 'Indicación Geógrafica': return 'AO'
+
+    if code == 'Trademark': return 'TRADEMARK'
+    if code == 'Registro de Marca': return 'TRADEMARK'
+    if code == 'Renovación de Marca': return 'TRADEMARK'
+
+    raise Exception('Type "%s" is not mapped.' % code)
+
+def translate_kind(trademark, header):
+    subcode = header.TransactionSubCode
+
+    if not subcode:
+        return ['Undefined']
+
+    if subcode == 'Part A': return ['Individual']
+    if subcode == 'Part B': return ['Individual']
+    if subcode == 'National': return ['Individual']
+
+    if subcode == 'Marca de Producto': return ['Individual']
+    if subcode == 'Marca de Servicios': return ['Individual']
+    if subcode == 'Marca de Servicio (Ren.)': return ['Individual']
+    if subcode == 'Marca de Producto (Ren.)': return ['Individual']
+
+    if subcode == 'Denominación de Origen': return ['Other']
+    if subcode == 'Indicación Geógrafica': return ['Other']
+
+    return ['Other']
+    #raise Exception('Kind "%s" not mapped.' % subcode)
+
+def translate_status(trademark):
+    status = trademark.MarkCurrentStatusCode
+
+    if status == 'TM Applications Received in Error': return 'Ended'
+
+    return ipas.translate_status(status)
+
+def translate_feature(trademark):
+    feature = trademark.MarkFeature
+
+    if not feature: return 'Undefined'
+
+    if feature == 'Denominativa': 
+        return 'Word'
+
+    if feature == "Mixta": 
+        return 'Combined'
+
+    if feature == "Figurativa": 
+        return "Figurative"
+
+    if feature == "Tridimensional":
+        return 'Three dimensional';
+
+    if feature == 'Olfativa':
+        return 'Olfactory';
+
+    if feature == "Sonora": 
+        return "Sound"    
+    #else:
+    #   raise Exception('feature "%s" not mapped.' % feature) 
+    
+    return ipas.translate_feature(feature)
+
+def verbal_lang_map(markVerbalElements, applang=None):
+    return ipas.verbal_lang_map(markVerbalElements, applang=applang)
+
+def translate_event(event):
+    if event == 'TM Applications Received in Error': return 'Withdrawn'
+    return ipas.translate_event(event)
+
+def get_registration_nb(trademark, tmstatus):
+    if trademark.RegistrationNumber:
+        return trademark.RegistrationNumber
+
+    if not tmstatus in ['Expired', 'Registered']:
+        return None
+
+    # PG/M/1/062947 => 1/062947
+    appnum_parts = trademark.ApplicationNumber.split('/')
+    regnum = '%s/%s' % (appnum_parts[-2], appnum_parts[-1])
+    return regnum
+
+def get_expiry_date(trademark, tmstatus):
+    return ipas.get_expiry_date(trademark, tmstatus)
+
+def get_registration_date(trademark, tmstatus):
+    return ipas.get_registration_date(trademark, tmstatus)
+
+# no international for PG
+def is_international(header):
+    return False
+
+# never accessed
+def get_ir_refnum(appnum):
+    return
+
+def get_goods_services(goods_services):
+    return ipas.get_goods_services(goods_services)
+
+def image_filename_extension(filename, extension_element):
+    if extension_element:
+        return filename + "." + extension_element.lower()
+    else:
+        return filename
+
+def get_publication_date(publications):
+    # in the publication information, in case:
+    # PublicationSection == "Registration"
+    # the associated PublicationDate is the publicationDate
+    if publications == None:
+        return None
+    if isinstance(publications, list):
+        for publication in publications:
+            if 'PublicationSection' in publication and publication['PublicationSection'] == 'Registration':
+                if 'PublicationDate' in publication:
+                    return publication['PublicationDate']
+    else:
+        if "Publication" in publications:
+            publication = publications["Publication"]
+            if 'PublicationDate' in publication:
+                return publication['PublicationDate']
+    return None

gbdtransformation/brands/pytm/template.yml

@@ -0,0 +1,40 @@
+{% include "ipas/template.yml" %}
+
+{% from 'navigation.tmpl' import match %}
+
+{% call(header) match('TradeMarkTransactionBody.TransactionContentDetails', Transaction) %}
+{% call(trademark) match('TransactionData.TradeMarkApplication.TradeMarkDetails.TradeMark', header) %}
+
+markImageDetails:
+  {% call(img) match('MarkImageDetails.MarkImage', trademark) %}
+    - name: {{ img.MarkImageFilename | image_filename_extension(img.MarkImageFileFormat) }}
+      {% call(cclaim) match('MarkImageColourClaimedText', img) %}
+      {% if not cclaim.__value  == 'N/A' %}
+      colourIndicator: {{ cclaim.__value | remove_trailing('-') | get_true_or_false }}
+      colourClaimed:
+        - text: {{ cclaim.__value | remove_trailing('-') }}
+          languageCode: {{  cclaim.__value | remove_trailing('-') | guess_language(cclaim._languageCode, trademark.ApplicationLanguageCode) }}
+      {% endif %}
+      {% endcall %}
+      {% call(category) match('MarkImageCategory', img) %}
+      classification:
+        kind: {{ category.CategoryKind }}
+        version: {{ category.CategoryVersion | parse_version }}
+        code:
+          {% call(vc) match('CategoryCodeDetails.CategoryCode', category) %}
+            - {{ vc }}
+          {% endcall %}
+      {% endcall %}
+  {% endcall %}
+
+publications:
+  {% call(publication) match('PublicationDetails.Publication', trademark) %}
+  - identifier: {{ publication.PublicationIdentifier }}
+    date: {{ publication.PublicationDate }}
+    section: {{ publication.PublicationSection }}
+  {% endcall %}
+
+publicationDate: {{ trademark.PublicationDetails | get_publication_date | convertdate('%Y-%m-%d')}}
+
+{% endcall %}
+{% endcall %}

gbdtransformation/brands/qatm/__init__.py

@@ -0,0 +1,5 @@
+render = 'JSON'
+source = 'national'
+
+# QA/T/1/188453
+appnum_mask = [ 'QA/T/1/(\\d*)' ]