wipo-gbd-transformation 1.1.67__py3-none-any.whl → 1.1.69__py3-none-any.whl

gbdtransformation/brands/phtm/filters.py

@@ -1,10 +1,59 @@
 from datetime import datetime
+import gbdtransformation.brands.ipas.filters as ipas
 
 # -------------------------------------------------------------
 # data translation helpers:
 # translate values from office interpretation to gbd equivalent
 # -------------------------------------------------------------
 
+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 clean_application_number(number):
+    # PH/4/1981/00000115 -> 4/1981/00000115
+    if number.startswith("PH/"):
+        number = number.replace("PH/", "")
+    return number
+
+def get_registration_nb(trademark, tmstatus):
+    if trademark.RegistrationNumber:
+        return trademark.RegistrationNumber
+
+    if not tmstatus in ['Expired', 'Registered']:
+        return None
+
+    # 4/1981/00000115 
+    appnum = clean_application_number(trademark.ApplicationNumber)
+    return appnum
+
+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)
+
+def translate_type(header):
+    code = header.TransactionCode
+
+    if code == 'Trademark': return 'TRADEMARK'
+    if code == 'Trademarks': return 'TRADEMARK'
+
+    raise Exception('Type "%s" is not mapped.' % code)
+
+def translate_kind(trademark, header):
+    subcode = header.TransactionSubCode
+
+    if subcode == 'Part A': return ['Individual']
+    if subcode == 'Part B': return ['Individual']
+    if subcode == 'National': return ['Individual']
+    if subcode == 'Trademark (national)': return ['Individual']
+
+    raise Exception('Kind "%s" not mapped.' % subcode)
+
 def convertdate2(date, input_formats, output_format="%Y-%m-%d"):
     if not date: return None
 
@@ -61,15 +110,31 @@ def translate_status(record):
 
     raise Exception('Status "%s" unmapped' % status)
 
+def translate_status(trademark):
+    status = trademark.MarkCurrentStatusCode
+
+    if status == 'TM Applications Received in Error': return 'Ended'
+
+    return ipas.translate_status(status)
+
+def translate_event(event):
+    if event == 'TM Applications Received in Error': return 'Withdrawn'
+    return ipas.translate_event(event)
+
+def translate_feature(trademark):
+    feature = trademark.MarkFeature
 
-def translate_feature(feature):
     if not feature: return 'Undefined'
 
     if feature == 'B': return 'Combined'
     if feature == 'L': return 'Figurative'
     if feature == 'N': return 'Word'
 
-    raise Exception('Feature "%s" unmapped' % feature)
+    return ipas.translate_feature(feature)
+    #raise Exception('Feature "%s" unmapped' % feature)
+
+def verbal_lang_map(markVerbalElements, applang=None):
+    return ipas.verbal_lang_map(markVerbalElements, applang=applang)
 
 def get_address(record):
     if not record: return None
@@ -79,3 +144,26 @@ def get_address(record):
     addr = [x for x in addr if x]
 
     return ', '.join(addr)
+
+# no international for PH
+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 get_file_name(img):
+    if img == None:
+        return None
+    result = ""
+    if img.MarkImageFilename:
+        result += img.MarkImageFilename
+    if img.MarkImageFileFormat:
+        result += "." + img.MarkImageFileFormat.lower()
+    if len(result) == 0:
+        return None
+    return result

gbdtransformation/brands/phtm/template.yml

@@ -1 +1,189 @@
-{% include "ipas/template.yml" %}
+{% 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 | get_appdate(trademark.ApplicationNumber) %}
+
+
+gbdStatus: {{ tmstatus }}
+officeStatus: {{ trademark.MarkCurrentStatusCode | parseStatus }}
+statusDate: {{ trademark.MarkCurrentStatusDate }}
+publicationDate: {{ (trademark.PublicationDetails.Publication | last).PublicationDate }}
+
+markFeature: {{ trademark | translate_feature }}
+
+st13: {{ trademark.ApplicationNumber | clean_application_number | st13(trademark.RegistrationOfficeCode, type=type, appdate=appdate) }}
+applicationNumber: {{ trademark.ApplicationNumber | clean_application_number }}
+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 %}

{wipo_gbd_transformation-1.1.67.dist-info → wipo_gbd_transformation-1.1.69.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wipo-gbd-transformation
-Version: 1.1.67
+Version: 1.1.69
 Summary: GBD XML ETL package
 Home-page: https://github.com/GBD-Wipo/xmlE
 Author: WIPO GDB team

{wipo_gbd_transformation-1.1.67.dist-info → wipo_gbd_transformation-1.1.69.dist-info}/RECORD

@@ -320,11 +320,11 @@ gbdtransformation/brands/pgtm/template.yml,sha256=PO7s1HDQM9ushIJuIX3z_dfWO-f62Y
 gbdtransformation/brands/pgtm/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 gbdtransformation/brands/pgtm/tests/pgtm.xml,sha256=fAzAz2VtqOFV_2QImDbNxDvuTr-Ue3e5tGx8h-Lnnvg,6533
 gbdtransformation/brands/phtm/__init__.py,sha256=UHmbQDIPDdApISBKfO9tKOX6LgUQ_Ib-IVMR5kCVMTY,86
-gbdtransformation/brands/phtm/filters.py,sha256=yNBSktkG4dBGe_E8vxT6N4k6kwkM1A2llNLD4lHVh88,3599
+gbdtransformation/brands/phtm/filters.py,sha256=jaMELkuv4Expzfl6-mr5JZiDqvMHGc0k2rXs_t-6i3g,6186
 gbdtransformation/brands/phtm/schema,sha256=Nb5tI5MUrzn19c8GpLFuJhpiLn0Fa9XPza10eNHeesI,2877
 gbdtransformation/brands/phtm/schema.classic,sha256=3JOKHUfK0jSo0NBlDmeGFAKqfYdMJOrIPBIoNUMrVFI,808
 gbdtransformation/brands/phtm/template.classic.yml,sha256=U5th90SpXjspWTPuimqftd8vZfJ3tT90mIud5n7Zv8w,2820
-gbdtransformation/brands/phtm/template.yml,sha256=PO7s1HDQM9ushIJuIX3z_dfWO-f62YDzBG_sYKDlnG8,34
+gbdtransformation/brands/phtm/template.yml,sha256=dCUBI8kiipYp6UEU2ebvlCnyCqadJ3I9rMgUhuXGbCw,7707
 gbdtransformation/brands/qatm/__init__.py,sha256=NBdOewZ1F_3eErahjyR-up8bjz1FSxwEiPSJfDw6GxY,79
 gbdtransformation/brands/qatm/filters.py,sha256=lMPVBX2ProdUtg5LcuQAmlInoGCo1-JZemHrvE1lNvw,2330
 gbdtransformation/brands/qatm/schema,sha256=AP0MxQyD0hY4APRh8nxitlxMqJYJB4AaaTJ8y20-XBA,3283
@@ -584,9 +584,9 @@ gbdtransformation/utilities/st66.xsd,sha256=co8aFN3a5TpudllRttWmfLeiZu8ulNipfeXm
 schemas/ShazamConfig.py,sha256=D67os5B11C41h_WZ7kk54Ss0Kk7tHh8W0d_1c_aX-lY,1191
 schemas/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 schemas/schema_extractor.py,sha256=3-ImtnI777f6b3VA0A_w-NoXdlGz5VZMzK6MnPdQQAY,10294
-wipo_gbd_transformation-1.1.67.dist-info/LICENSE.md,sha256=6r2dL13EwZqSt2ellLbJRFTA-6ECIDOer4YthCfkac0,35654
-wipo_gbd_transformation-1.1.67.dist-info/METADATA,sha256=kQvCKqeGgGHBMExSGZSApJ94CKTrVQfSKwDHY4zvYr0,577
-wipo_gbd_transformation-1.1.67.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-wipo_gbd_transformation-1.1.67.dist-info/entry_points.txt,sha256=NFLtlP3mPHUi-hEoUcz4CXa7vcpP8bbwd18HS4arbEk,223
-wipo_gbd_transformation-1.1.67.dist-info/top_level.txt,sha256=oU1j-JNLga18Fd-EV6Xl9wM8zxYoNVEzb7P8MDhTPJg,26
-wipo_gbd_transformation-1.1.67.dist-info/RECORD,,
+wipo_gbd_transformation-1.1.69.dist-info/LICENSE.md,sha256=6r2dL13EwZqSt2ellLbJRFTA-6ECIDOer4YthCfkac0,35654
+wipo_gbd_transformation-1.1.69.dist-info/METADATA,sha256=Rffs9LzOfUQ1cBm9Z6wAMK2vxa_XUieOtgXSV2P6gyA,577
+wipo_gbd_transformation-1.1.69.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+wipo_gbd_transformation-1.1.69.dist-info/entry_points.txt,sha256=NFLtlP3mPHUi-hEoUcz4CXa7vcpP8bbwd18HS4arbEk,223
+wipo_gbd_transformation-1.1.69.dist-info/top_level.txt,sha256=oU1j-JNLga18Fd-EV6Xl9wM8zxYoNVEzb7P8MDhTPJg,26
+wipo_gbd_transformation-1.1.69.dist-info/RECORD,,