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

gbdtransformation/brands/detm/template.yml

@@ -0,0 +1,151 @@
+{% from 'navigation.tmpl' import match %}
+
+{% call(trademark) match('CURRENT', MARKDOC) %}
+{% set (gbdStatus, officeStatus) = trademark | translate_status %}
+
+type: TRADEMARK
+kind: {{ trademark.MARKENKATEGORIE | translate_kind }}
+
+markFeature: {{ trademark.MARKTYPE | translate_feature }}
+
+registrationOfficeCode: DE
+designatedCountries:
+  - DE
+
+st13: {{ trademark.NR | st13('DE') }}
+
+applicationNumber: {{ trademark.FILENR | replace('.', '') }}
+applicationDate: {{ trademark.FILDATE }}
+
+{% if trademark.REGDATE %}
+registrationNumber: {{ trademark.NR | replace('DE', '') }}
+registrationDate: {{ trademark.REGDATE }}
+{% endif %}
+
+publicationDate: {{ trademark.PUBDATE }}
+
+applicationLanguageCode: de
+
+expiryDate: {{ trademark | get_expiry_date(gbdStatus)}}
+{% if gbdStatus == 'Ended' %}
+terminationDate:  {{ trademark.PROCDATE | convertdate('%Y-%m-%dT%H:%M:%S') }}
+{% endif %}
+
+officeStatus: {{ officeStatus }}
+gbdStatus:  {{ gbdStatus }}
+statusDate: {{ trademark.PROCDATE | convertdate('%Y-%m-%dT%H:%M:%S') }}
+
+{% call(desc) match('MARKDESCR.MARKDESCRTEXT', trademark) %}
+markDescriptionDetails:
+  - languageCode: de
+    text: {{ desc }}
+{% endcall %}
+
+{% call(text) match('MARKTEXT', trademark) %}
+wordMarkSpecification:
+  markVerbalElement:
+    - languageCode: {{ text | guess_language('de') }}
+      text: {{ text }}
+{% endcall %}
+
+{% if (trademark.IMAGENAME) %}
+markImageDetails:
+  - name: {{ trademark.FILENR }}
+    {% if trademark.COLOURGR %}
+    colourIndicator: true
+    colourClaimed:
+      - languageCode: de
+        text: {{ trademark.COLOURGR.COLOUR }}
+    {% endif %}
+    {% if trademark.VIENNAGR %}
+    classification:
+      kind: Vienna
+      version: {{ ASK_THE_OFFICE }}
+      code:
+      {% call (class) match ('VIENNAGR.VIENNACL', trademark) %}
+        - {{ class }}
+      {% endcall %}
+    {% endif %}
+{% endif %}
+
+{% call(nc_gs) match('TLT', trademark) %}
+goodsServicesClassification:
+  kind: Nice
+  version: {{ ASK_THE_OFFICE }}
+  class:
+  {% call(nice) match('NICEGR', nc_gs) %}
+    - code: {{ nice.NICECLMAIN or nice.NICECLOTHER | int }}
+      terms:
+      {% if nice.LGS | has_value %}
+        de:
+          {% for term in nice.LGS | split_terms %}
+          - {{ term }}
+          {% endfor %}
+      {% endif %}
+  {% endcall %}
+{% endcall %}
+{% call(nc_gs) match('NOTLT', trademark) %}
+goodsServicesClassification:
+  kind : Nice
+  version: {{ ASK_THE_OFFICE }}
+  class:
+    - code: {{ nc_gs.NICECLMAIN | int }}
+    {% if nc_gs.NICECOTHER %}
+    {% for code in nc_gs.NICECLOTHER %}
+    - code: {{ code | int }}
+    {% endfor %}
+    {% endif %}
+    {% if nc_gs.LGSCOMPLETE %}
+    - terms:
+         de: 
+           {% for term in nc_gs.LGSCOMPLETE | split_terms %}
+          - {{ term }}
+           {% endfor %}
+    {% endif %}
+{% endcall %}
+priorities:
+  - countryCode:
+    number:
+    date:
+    comment:
+
+publications:
+  - identifier:
+    date:
+    section:
+
+applicants:
+{% call(applicant) match('OWNERGR.OWNER', trademark) %}
+  - fullName:
+      - languageCode: {{ applicant.OWNAME | guess_language('de') }}
+        text: {{ applicant.OWNAME }}
+    fullAddress:
+      - languageCode: {{ applicant.OWCITY | guess_language('de') }}
+        text: {{ applicant.OWCITY }}
+    countryCode: {{ applicant.OWCC }}
+{% endcall %}
+
+representatives:
+{% call(representative) match('AGENT', trademark) %}
+  - fullName:
+      - languageCode: {{ representative.AGNAME | guess_language('de') }}
+        text: {{ representative.AGNAME }}
+    fullAddress:
+      - languageCode: {{ representative.AGCITY | guess_language('de') }}
+        text: {{ representative.AGCITY }}
+    countryCode: {{ representative.AGCC }}
+{% endcall %}
+
+{% if trademark.DELIVERYADDR %}
+correspondence:
+  fullAddress:
+    - languageCode: de
+      text: {{ trademark.DELIVERYADDR }}
+  countryCode:
+{% endif %}
+
+extra:
+  {% if trademark.STATUSOPPOSABLE %}
+  opposable: true
+  {% endif %}
+{% endcall %}

gbdtransformation/brands/dktm/__init__.py

@@ -0,0 +1,7 @@
+# instruction to render the output to JSON format
+render = 'JSON'
+source = 'national'
+
+# VA 1963 01864
+appnum_mask = [ '(VA) \\d{4} (\\d*)',
+                '(FA) \\d{4} (\\d*)' ]

gbdtransformation/brands/dktm/filters.py

@@ -0,0 +1,90 @@
+# namespaces defined in XML and to be ignored in procecssing
+ignore_namespace = ['http://dk.tmview.europa.eu/trademark/data',
+                    'http://www.w3.org/2001/XMLSchema-instance',
+                    'http://dk.tmview.europa.eu/trademark/data',
+                    'http://tm-xml.org/schema/DK-TM-Search-TradeMark-V1-2.xsd']
+
+# -------------------------------------------------------------
+# data translation helpers:
+# translate values from office interpretation to gbd equivalent
+# -------------------------------------------------------------
+def get_appyear(appnum):
+    return appnum.split(' ')[1]
+
+def get_termination(value, gbd_status):
+    if gbd_status == 'Ended':
+        return value
+    return None
+
+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
+
+def  get_addr(addr):
+    if not addr: return None
+    return " ".join(addr.FreeFormatAddressLine)
+
+def  get_name(name):
+    if not name: return None
+    if name.OrganizationName:
+        return name.OrganizationName
+    return "%s %s" % (name.FirstName, name.LastName )
+
+def translate_kind(kind):
+    if not kind: return ['Individual']
+
+    if kind == 'Individual Mark': return ['Individual']
+    if kind == 'Collective Mark': return ['Collective']
+    if kind == 'Certification- and Guarantee Mark': return ['Certificate']
+    if kind == 'Collective Mark, a Certification Mark or a Guarantee Mark': return ['Collective', 'Certificate']
+
+    # raise Exception to recognize unmapped values
+    raise Exception('kind "%s" is not mapped.' % kind)
+
+def translate_status(status):
+    """translation of mark status"""
+    # a required data from office. if not present and no way to guess,
+    # return Unknown
+    if not status: return 'Unknown'
+
+    if status in ['Application accepted',
+                  'Application published',
+                  'Classification checked' ]:
+        return 'Pending'
+
+    if status in ['Application refused',
+                  'Application withdrawn',
+                  'Registration cancelled',
+                  'Registration surrendered']:
+        return 'Ended'
+
+    if status in [ 'Registered',
+                   'Revocation proceeding pending',
+                   'STATUS UNKNOWN']:
+        return 'Registered'
+
+    if status == 'Expired':
+        return 'Expired'
+
+    raise Exception('Status "%s" unmapped' % status)
+
+
+def translate_feature(feature):
+    if not feature: return 'Undefined'
+
+    if feature == '3D shape': return 'Three dimensional'
+    if feature == 'Figurative': return 'Figurative'
+    if feature == 'Word': return 'Figurative'
+    if feature == 'Pattern': return 'Pattern'
+    if feature == 'Motion': return 'Motion'
+    if feature == 'Colour': return 'Colour'
+    if feature == 'Position': return 'Position'
+    if feature == 'Sound': return 'Sound'
+
+    raise Exception('Feature "%s" unmapped' % feature)
+

gbdtransformation/brands/dktm/schema

@@ -0,0 +1,95 @@
+/Transaction
+__/TradeMarkTransactionBody
+____/TransactionContentDetails
+______/TransactionCode
+______/TransactionData
+________/TradeMarkDetails
+__________/TradeMark
+____________/ApplicantDetails
+______________/ApplicantKey
+________________/Applicant
+__________________/ApplicantAddressBook
+____________________/FormattedNameAddress
+______________________/Address
+________________________/AddressCountryCode
+________________________/FreeFormatAddress
+__________________________/FreeFormatAddressLine
+______________________/Name
+________________________/FormattedName
+__________________________/FirstName
+__________________________/LastName
+__________________________/OrganizationName
+__________________/ApplicantIdentifier
+__________________/ApplicantLegalEntity
+________________/URI
+____________/ApplicationDate
+____________/ApplicationNumber
+____________/Comment
+____________/ExhibitionPriorityDetails
+______________/ExhibitionPriority
+________________/ExhibitionCountryCode
+________________/ExhibitionDate
+________________/ExhibitionName
+____________/ExpiryDate
+____________/GoodsServicesDetails
+______________/GoodsServices
+________________/ClassDescriptionDetails
+__________________/ClassDescription
+____________________/ClassNumber
+____________________/GoodsServicesDescription
+____________________/GoodsServicesDescription[@languageCode=da]
+____________/KindMark
+____________/MarkCurrentStatusCode
+____________/MarkCurrentStatusDate
+____________/MarkFeature
+____________/MarkImageDetails
+______________/MarkImage
+________________/MarkImageCategory
+__________________/CategoryCodeDetails
+____________________/CategoryCode
+________________/MarkImageURI
+____________/OppositionDetails
+______________/Opposition
+________________/OpponentDetails
+__________________/Opponent
+________________/OppositionDate
+________________/OppositionEventDetails
+__________________/OppositionEvent
+____________________/OppositionEventCode
+____________________/OppositionEventDate
+________________/OppositionIdentifier
+____________/PriorityDetails
+______________/Priority
+________________/PriorityCountryCode
+________________/PriorityDate
+________________/PriorityNumber
+____________/RegistrationDate
+____________/RegistrationNumber
+____________/RegistrationOfficeCode
+____________/RepresentativeDetails
+______________/RepresentativeKey
+________________/Representative
+__________________/RepresentativeAddressBook
+____________________/FormattedNameAddress
+______________________/Address
+________________________/AddressCountryCode
+________________________/FreeFormatAddress
+__________________________/FreeFormatAddressLine
+______________________/Name
+________________________/FormattedName
+__________________________/FirstName
+__________________________/LastName
+__________________________/OrganizationName
+__________________/RepresentativeIdentifier
+__________________/RepresentativeLegalEntity
+________________/URI
+____________/SeniorityDetails
+______________/Seniority
+________________/SeniorityBeenClaimedNumber
+____________/WordMarkSpecification
+______________/MarkVerbalElementText
+______/TransactionIdentifier
+__/TransactionHeader
+____/SenderDetails
+______/RequestProducerDateTime
+________________/DK-TM-Search-TradeMark-V1-2.xsd

gbdtransformation/brands/dktm/template.yml

@@ -0,0 +1,114 @@
+{% from 'navigation.tmpl' import match %}
+{% set TradeMark = Transaction.TradeMarkTransactionBody.TransactionContentDetails.TransactionData.TradeMarkDetails.TradeMark %}
+
+{% set status = TradeMark.MarkCurrentStatusCode | translate_status %}
+{% set appyear = TradeMark.ApplicationNumber | get_appyear %}
+
+type: TRADEMARK
+kind: {{TradeMark.KindMark | translate_kind }}
+st13: {{ TradeMark.ApplicationNumber | st13('DK', appdate=appyear) }}
+
+markFeature: {{ TradeMark.MarkFeature | translate_feature }}
+registrationOfficeCode: {{ TradeMark.RegistrationOfficeCode }}
+designatedCountries:
+  - {{ TradeMark.RegistrationOfficeCode }}
+applicationNumber: {{ TradeMark.ApplicationNumber }}
+applicationDate: {{ TradeMark.ApplicationDate | convertdate('%Y-%m-%d') }}
+registrationNumber: {{ TradeMark | get_registration_nb(TradeMark.MarkCurrentStatusCode)}}
+registrationDate: {{ TradeMark.RegistrationDate }}
+applicationLanguageCode: 'da'
+expiryDate: {{ TradeMark.ExpiryDate }}
+terminationDate: {{ TradeMark.MarkCurrentStatusDate | get_termination(status) }}
+officeStatus: {{ TradeMark.MarkCurrentStatusCode }}
+gbdStatus: {{ status }}
+statusDate: {{ TradeMark.MarkCurrentStatusDate | convertdate('%Y-%m-%d') }}
+markDisclaimerDetails:
+  {% call(desc) match('MarkDisclaimerDetails.MarkDisclaimer', TradeMark) %}
+  - text: {{ desc }}
+    languageCode: {{ desc | guess_language(desc._languageCode, 'da') }}
+  {% endcall %}
+markDescriptionDetails:
+  {% call(desc) match('MarkDescriptionDetails.MarkDescription', TradeMark) %}
+  - text: {{ desc }}
+    languageCode: {{ desc | guess_language(desc._languageCode, 'da') }}
+  {% endcall %}
+wordMarkSpecification:
+  markVerbalElement:
+    {% call(desc) match('WordMarkSpecification.MarkVerbalElementText', TradeMark) %}
+    - text: {{ desc }}
+      languageCode: {{ desc | guess_language(desc._languageCode, 'da') }}
+    {% endcall %}
+markImageDetails:
+  {% call(img) match('MarkImageDetails.MarkImage', TradeMark) %}
+  - name: {{ img.MarkImageURI }}
+    classification:
+      kind: Vienna
+      code:
+      {% call(code) match('MarkImageCategory.CategoryCodeDetails.CategoryCode', img) %}
+        - {{ code }}
+      {% endcall %}
+  {% endcall %}
+
+{% call(nc_gs) match('GoodsServicesDetails.GoodsServices', TradeMark) %}
+goodsServicesClassification:
+  kind: Nice
+  version: {{ ASK_THE_OFFICE }}
+  class:
+    {% call(nice) match('ClassDescriptionDetails.ClassDescription', nc_gs) %}
+    - code: {{ nice.ClassNumber | int }}
+      terms:
+      {% if nice.GoodsServicesDescription | has_value %}
+      {% call(desc) match('GoodsServicesDescription', nice) %}
+        {{ desc | guess_language(desc._languageCode, 'da') | field_name }}:
+        {% for gsline in desc | remove_trailing('.') | split_terms %}
+          - {{ gsline | lower }}
+        {% endfor %}
+      {% endcall %}
+      {% endif %}
+    {% endcall %}
+{% endcall %}
+
+priorities:
+  {% call(priority) match('PriorityDetails.Priority', TradeMark) %}
+    - countryCode: {{ priority.PriorityCountryCode }}
+      number: {{ priority.PriorityNumber }}
+      date: {{ priority.PriorityDate }}
+  {% endcall %}
+
+applicants:
+  {% call(Applicant) match('ApplicantDetails.ApplicantKey.Applicant', TradeMark) %}
+  - identifier: {{ Applicant.ApplicantIdentifier }}
+    kind: {{ 'Legal entity' if Applicant.ApplicantLegalEntity else 'Natural person' }}
+    fullName:
+      {% call(nameline) match('FormattedNameAddress.Name.FormattedName', Applicant.ApplicantAddressBook) %}
+      - text: {{ nameline | get_name}}
+        languageCode: da
+      {% endcall %}
+    fullAddress:
+      {% call(adrline) match('FormattedNameAddress.Address.FreeFormatAddress', Applicant.ApplicantAddressBook) %}
+      - text: {{ adrline | get_addr}}
+        languageCode: da
+      {% endcall %}
+    {% call(adrline) match('FormattedNameAddress.Address', Applicant.ApplicantAddressBook) %}
+    countryCode: {{ adrline.AddressCountryCode }}
+    {% endcall %}
+  {% endcall %}
+
+representatives:
+  {% call(Representative) match('RepresentativeDetails.RepresentativeKey.Representative', TradeMark) %}
+  - identifier: {{ Representative.RepresentativeIdentifier }}
+    kind: {{ 'Legal entity' if Representative.RepresentativeLegalEntity else 'Natural person' }}
+    fullName:
+      {% call(nameline) match('FormattedNameAddress.Name.FormattedName', Representative.RepresentativeAddressBook) %}
+      - text: {{ nameline | get_name}}
+        languageCode: da
+      {% endcall %}
+    fullAddress:
+      {% call(adrline) match('FormattedNameAddress.Address.FreeFormatAddress', Representative.RepresentativeAddressBook) %}
+      - text: {{ adrline | get_addr}}
+        languageCode: da
+      {% endcall %}
+    {% call(adrline) match('FormattedNameAddress.Address', Representative.RepresentativeAddressBook) %}
+    countryCode: {{ adrline.AddressCountryCode }}
+    {% endcall %}
+  {% endcall %}

gbdtransformation/brands/dztm/__init__.py

@@ -0,0 +1,10 @@
+render = 'JSON'
+source = 'national'
+
+# DZ/T/2011/001877
+appnum_mask = 'DZ/T/\\d{4}/(\\d*)'
+
+# 1/093368
+# T88988
+regnum_mask = [ '1/(\\d.*)',
+                '(.*)']

gbdtransformation/brands/dztm/filters.py

@@ -0,0 +1,81 @@
+import gbdtransformation.brands.ipas.filters as ipas
+import gbdtransformation.common.filters as commons
+
+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]
+
+def translate_type(header):
+    code = header.TransactionCode
+
+    if code == 'Marque Nationale': return 'TRADEMARK'
+    if code == 'Marque Divisionelle': return 'TRADEMARK'
+
+    # no way to deduce the IR (ask the office)
+    if code == 'Marque Madrid': return 'TRADEMARK'
+
+    raise Exception('Type "%s" is not mapped.' % code)
+
+def translate_kind(trademark, header):
+    code = header.TransactionCode
+    subcode = header.TransactionSubCode
+
+    if subcode == 'Nationale Prod & Services': return ['Individual']
+    if subcode == 'Nationale Collective': return ['Collective']
+
+    if code == 'Marque Divisionelle': return ['Other']
+    if code == 'Marque Madrid': return ['Individual']
+
+    raise Exception('Kind "%s" not mapped.' % subcode)
+
+def translate_status(trademark):
+    status = trademark.MarkCurrentStatusCode
+
+    if status == '3860': return 'Unknown'
+
+    return ipas.translate_status(status)
+
+def translate_feature(trademark):
+    feature = trademark.MarkFeature
+
+    if not feature: return 'Undefined'
+
+    return ipas.translate_feature(feature)
+
+def translate_event(event):
+    return ipas.translate_event(event)
+
+# ---------------------------------------
+
+# TODO: split on language cahnge {'fr': ['SABBAQLI سبقلي']}
+def verbal_lang_map(markVerbalElements, applang=None):
+    return ipas.verbal_lang_map(markVerbalElements, applang=applang)
+
+def get_registration_nb(trademark, tmstatus):
+    if trademark.RegistrationNumber:
+        return trademark.RegistrationNumber
+
+    if not tmstatus in ['Expired', 'Registered']:
+        return None
+
+    raise Exception('!!')
+
+    return None
+
+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 is_international(content):
+    return False
+
+def get_ir_refnum(appnum):
+    return
+
+def get_goods_services(goods_services):
+    return ipas.get_goods_services(goods_services)

gbdtransformation/brands/dztm/schema

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

gbdtransformation/brands/dztm/template.yml

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

gbdtransformation/brands/eetm/__init__.py

@@ -0,0 +1,8 @@
+# instruction to render the output to JSON format
+render = 'JSON'
+source = 'national'
+
+# M200701818
+# 9801818
+appnum_mask = [ 'M\\d{4}(\\d*)([A-Z]{0,2}?)',
+                '\\d{2}(\\d*)([A-Z]{0,2}?)' ]