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

gbdtransformation/brands/jotm/tests/test.xml

@@ -0,0 +1,84 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<Transaction xmlns="http://www.wipo.int/standards/XMLSchema/trademarks" xmlns:wo="http://www.wipo.int/standards/XMLSchema/wo-trademarks">
+  <TradeMarkTransactionBody>
+    <TransactionContentDetails>
+      <TransactionIdentifier>M</TransactionIdentifier>
+      <TransactionCode>Trademark</TransactionCode>
+      <TransactionSubCode>Mark</TransactionSubCode>
+      <TransactionData>
+        <TradeMarkApplication>
+          <TradeMarkDetails>
+            <TradeMark>
+              <RegistrationOfficeCode>TO</RegistrationOfficeCode>
+              <ApplicationNumber>2017/3420</ApplicationNumber>
+              <ApplicationDate>2017-07-26</ApplicationDate>
+              <ApplicationLanguageCode>en</ApplicationLanguageCode>
+              <MarkCurrentStatusDate>2017-09-04</MarkCurrentStatusDate>
+              <KindMark>Individual</KindMark>
+              <MarkImageDetails>
+                <MarkImage/>
+              </MarkImageDetails>
+              <GoodsServicesDetails>
+                <GoodsServices>
+                  <ClassDescriptionDetails>
+                    <ClassDescription>
+                      <ClassNumber>25</ClassNumber>
+                      <GoodsServicesDescription languageCode="en">Slippers</GoodsServicesDescription>
+                    </ClassDescription>
+                  </ClassDescriptionDetails>
+                </GoodsServices>
+              </GoodsServicesDetails>
+              <PublicationDetails>
+                <Publication>
+                  <PublicationDate>2017-11-30</PublicationDate>
+                </Publication>
+              </PublicationDetails>
+              <ApplicantDetails>
+                <Applicant>
+                  <ApplicantAddressBook>
+                    <FormattedNameAddress>
+                      <Name>
+                        <FreeFormatName>
+                          <FreeFormatNameDetails>
+                            <FreeFormatNameLine languageCode="en">Lei Signs</FreeFormatNameLine>
+                          </FreeFormatNameDetails>
+                        </FreeFormatName>
+                      </Name>
+                      <Address>
+                        <AddressCountryCode>TO</AddressCountryCode>
+                        <FreeFormatAddress>
+                          <FreeFormatAddressLine>Fund Management, Nuku'alofa</FreeFormatAddressLine>
+                        </FreeFormatAddress>
+                      </Address>
+                    </FormattedNameAddress>
+                  </ApplicantAddressBook>
+                </Applicant>
+              </ApplicantDetails>
+              <wo:WordMarkSpecification>
+                <wo:MarkVerbalElementText languageCode="en">TOKO</wo:MarkVerbalElementText>
+              </wo:WordMarkSpecification>
+              <wo:MarkEventDetails>
+                <wo:MarkEvent>
+                  <wo:MarkEventDate>2017-07-26</wo:MarkEventDate>
+                  <wo:MarkEventCode>Filed</wo:MarkEventCode>
+                </wo:MarkEvent>
+                <wo:MarkEvent>
+                  <wo:MarkEventDate>2017-11-30</wo:MarkEventDate>
+                  <wo:MarkEventCode>Published</wo:MarkEventCode>
+                </wo:MarkEvent>
+                <wo:MarkEvent>
+                  <wo:MarkEventDate>2017-09-04</wo:MarkEventDate>
+                  <wo:MarkEventCode>Examined</wo:MarkEventCode>
+                  <wo:OfficeSpecificMarkEventCode>1044</wo:OfficeSpecificMarkEventCode>
+                  <wo:OfficeSpecificMarkEventDescription languageCode="en">To Issue Publication Notice</wo:OfficeSpecificMarkEventDescription>
+                </wo:MarkEvent>
+              </wo:MarkEventDetails>
+              <wo:MarkCurrentStatusCode>Examined</wo:MarkCurrentStatusCode>
+            </TradeMark>
+          </TradeMarkDetails>
+        </TradeMarkApplication>
+      </TransactionData>
+    </TransactionContentDetails>
+  </TradeMarkTransactionBody>
+</Transaction>

gbdtransformation/brands/jptm/__init__.py

@@ -0,0 +1,6 @@
+# instruction to render the output to JSON format
+render = 'JSON'
+source = 'national' # national | multinational | international
+
+appnum_mask = [ '\\d{4}-(.*)', '(.*)' ]
+regnum_mask = '(.*)'

gbdtransformation/brands/jptm/filters.py

@@ -0,0 +1,79 @@
+import unicodedata
+
+# namespaces defined in XML and to be ignored in procecssing
+ignore_namespace = []
+
+
+# -------------------------------------------------------------
+# data translation helpers:
+# translate values from office interpretation to gbd equivalent
+# -------------------------------------------------------------
+
+def parse_appnum(appnum):
+    if len(appnum) > 4:
+        return '%s-%s' % (appnum[:4], appnum[4:])
+    else:
+        return appnum
+
+def get_verbal(wmspec):
+    # first try markVerbalElement
+    ve = wmspec.markVerbalElement
+    if ve: return ve
+
+    # fallback to markSignificantVerbalElement
+    sve = wmspec.markSignificantVerbalElement
+    if not sve: return
+
+    if hasattr(sve, 'text'): sve = sve.text
+
+    return ' '.join(sve) if isinstance(sve, list) else sve
+
+def get_signif(wmspec):
+    sve = wmspec.markSignificantVerbalElement
+    if not sve: return
+
+    if hasattr(sve, 'text'): sve = sve.text
+
+    return ' '.join(sve) if isinstance(sve, list) else sve
+
+def get_transliteration(wmspec):
+    trans = wmspec.markTransliteration
+    if not trans: return
+    if not isinstance(trans, list):
+        trans = [trans]
+    return ' '.join(trans)
+
+def try_to_8bit(value):
+    return unicodedata.normalize('NFKC', value)
+
+def translate_status(status):
+    if not status: return 'Unknown'
+
+    if status == 'Unknown': return 'Unknown'
+    if status == 'Domestic registration': return 'Registered'
+    if status == 'Domestic application': return 'Pending'
+    if status == 'International registration': return 'Registered'
+    if status == 'Domestic registration deletion case': return 'Expired'
+    if status == 'Domestic application deletion case': return 'Ended'
+    if status == 'International registration deletion case': return 'Expired'
+
+    raise Exception('Status "%s" unmapped' % status)
+
+
+def translate_feature(feature):
+    if not feature: feature = 'Undefined'
+
+    if feature == 'Colour': return 'Colour'
+    if feature == 'Sound': return 'Sound'
+    if feature == 'Motion': return 'Motion'
+    if feature == 'Hologram': return 'Hologram'
+    if feature == 'Position': return 'Position'
+    if feature == 'Other': return 'Other'
+    if feature == 'Three dimensional': return 'Three dimensional'
+
+    # TODO look if has word or has figure
+    if feature == 'Undefined': return 'Undefined'
+    if feature == 'Not a special trademark': return 'Undefined'
+
+    raise Exception('Feature "%s" unmapped' % feature)
+

gbdtransformation/brands/jptm/schema

@@ -0,0 +1,39 @@
+/brand
+__/applicants
+____/fullAddress
+____/fullName
+____/identifier
+__/applicationDate
+__/applicationLanguageCode
+__/applicationNumber
+__/designatedCountries
+__/expiryDate
+__/extra
+____/divisionNumber
+__/gbdStatus
+__/goodsServicesClassification
+____/class
+______/code
+______/term
+__/markFeature
+__/markImageDetails
+____/class
+__/officeStatus
+__/priorities
+____/countryCode
+____/date
+____/number
+__/registrationDate
+__/registrationNumber
+__/registrationOfficeCode
+__/representatives
+____/fullAddress
+____/fullName
+____/identifier
+____/kind
+__/statusDate
+__/type
+__/wordMarkSpecification
+____/markSignificantVerbalElement
+____/markTransliteration
+____/markVerbalElement

gbdtransformation/brands/jptm/template.yml

@@ -0,0 +1,113 @@
+{% from 'navigation.tmpl' import match %}
+
+{% set appnum = brand.applicationNumber | parse_appnum %}
+type: TRADEMARK
+kind:
+  - Individual
+markFeature: {{ brand.markFeature | translate_feature }}
+
+registrationOfficeCode: JP
+designatedCountries:
+  - JP
+
+reference:
+{% call (ref) match('reference.registration', brand) %}
+  office: WO
+  registration:
+    - number: {{ ref.number }}
+      date: {{ ref.date }}
+{% endcall %}
+
+# can be deduced from appnum given office cc and (optional) appdate
+st13: {{ appnum | st13('JP', appdate=brand.applicationDate) }}
+
+applicationNumber: {{ appnum }}
+applicationDate: {{ brand.applicationDate }}
+
+registrationNumber: {{ brand.registrationNumber }}
+registrationDate: {{ brand.registrationDate }}
+
+applicationLanguageCode: ja
+
+expiryDate: {{ brand.expiryDate }}
+
+officeStatus: {{ brand.officeStatus }}
+gbdStatus:  {{ brand.officeStatus  | translate_status }}
+statusDate: {{ brand.statusDate }}
+
+{% call(wmspec) match('wordMarkSpecification', brand) %}
+wordMarkSpecification:
+  {% set word = wmspec | get_verbal %}
+  {% if word %}
+  markVerbalElement:
+    - languageCode: ja
+      text: {{ word  | try_to_8bit }}
+  {% endif %}
+  {% set signif = wmspec | get_signif %}
+  {% if signif %}
+  markSignificantVerbalElement:
+    - languageCode: ja
+      text: {{ signif  | try_to_8bit }}
+  {% endif %}
+  markTransliteration: {{ wmspec | get_transliteration }}
+{% endcall %}
+
+{% call(img) match('markImageDetails', brand) %}
+markImageDetails:
+  - name: {{ brand.applicationNumber }}
+    classification:
+      kind: Vienna
+      version: {{ ASK_THE_OFFICE }}
+      code:
+      {% call(cls) match('class', img) %}
+        - {{ cls }}
+      {% endcall %}
+{% endcall %}
+
+{% call(nc_gs) match('goodsServicesClassification', brand) %}
+goodsServicesClassification:
+  kind: Nice
+  version: {{ ASK_THE_OFFICE }}
+  class:
+    {% call(nice) match('class', nc_gs) %}
+    - code: {{ nice.code | int }}
+      terms:
+        ja:
+          {% call(term) match('term', nice) %}
+          - {{ term }}
+          {% endcall %}
+    {% endcall %}
+{% endcall %}
+
+priorities:
+{% call(prio) match('priorities', brand) %}
+  - countryCode: {{ prio.countryCode }}
+    number: {{ prio.number }}
+    date: {{ prio.date | convertdate('%Y%m%d')}}
+{% endcall %}
+
+applicants:
+{% call(appl) match('applicants', brand) %}
+  - identifier: {{ appl.identifier | replace('nan', '')  }}
+    fullName:
+      - languageCode: ja
+        text: {{ appl.fullName | try_to_8bit }}
+    fullAddress:
+      - languageCode: ja
+        text: {{ appl.fullAddress  | try_to_8bit}}
+{% endcall %}
+
+representatives:
+{% call(repr) match('representatives', brand) %}
+  {% if repr.fullName | has_value %}
+  - identifier: {{ repr.identifier }}
+    fullName:
+      - languageCode: ja
+        text: {{ repr.fullName | try_to_8bit }}
+    {% if repr.fullAddress and repr.fullAddress != '（省略）' %}
+    fullAddress:
+      - languageCode: ja
+        text: {{ repr.fullAddress | try_to_8bit }}
+    {% endif %}
+  {% endif %}
+{% endcall %}

gbdtransformation/brands/ketm/__init__.py

@@ -0,0 +1,9 @@
+render = 'JSON'
+source = 'national'
+
+# MA/S/1/1893
+# MA/T/1/1847
+# IB/D/1/1101893
+# A/D/1/1034386
+appnum_mask = [ '[A-Z]{2}/([A-Z])/1/(\\d*)',
+                '([A-C])/(D)/1/(\\d*)' ]

gbdtransformation/brands/ketm/filters.py

@@ -0,0 +1,77 @@
+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 ipas.get_appdate(appdate, appnum)
+
+def translate_type(header):
+    code = header.TransactionCode
+
+    # extraction missing info.
+    if not code:
+        raise Exception('Incomplete Document Info')
+
+    if code == 'Trade Marks': return 'TRADEMARK'
+    if code == 'Madrid Marks': return 'TRADEMARK'
+    if code == 'Service Marks': return 'TRADEMARK'
+
+    raise Exception('Type "%s" is not mapped.' % code)
+
+def translate_kind(trademark, header):
+    code = header.TransactionCode
+
+    if code == 'Trade Marks': return ['Individual']
+    if code == 'Madrid Marks': return ['Individual']
+    if code == 'Service Marks': return ['Individual']
+
+    raise Exception('Kind "%s" not mapped.' % code)
+
+def translate_status(trademark):
+    status = trademark.MarkCurrentStatusCode
+
+    if status == 'Inactive':
+        if trademark.ExpiryDate: return 'Expired'
+        else: return 'Ended'
+
+    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)
+
+# ---------------------------------------
+
+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
+
+    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(header):
+    code = header.TransactionCode
+    return code == 'Madrid Marks'
+
+# IB/D/1/1020123
+def get_ir_refnum(appnum):
+    return appnum.split('/')[-1]
+
+def get_goods_services(goods_services):
+    return ipas.get_goods_services(goods_services)

gbdtransformation/brands/ketm/schema

@@ -0,0 +1,86 @@
+/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
+______________/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/ketm/template.yml

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

gbdtransformation/brands/kgtm/__init__.py

@@ -0,0 +1,6 @@
+# instruction to render the output to JSON format
+render = 'JSON'
+source = 'national' # national | multinational | international
+
+appnum_mask = ['(\\d*)\\.\\d', '(.*)']
+regnum_mask = '(.*)'

gbdtransformation/brands/kgtm/filters.py

@@ -0,0 +1,67 @@
+# standard gbd definitions
+from datetime import datetime
+
+from gbdtransformation.brands import kinds as std_kinds
+from gbdtransformation.brands import status as std_status
+from gbdtransformation.brands import features as std_features
+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)
+
+def translate_status(expiryDate):
+    """translation of mark status"""
+    # a required data from office. if not present and no way to guess,
+    # return Unknown
+    if not expiryDate: return 'Unknown'
+
+    if datetime.now().strftime('%Y-%m-%d') > expiryDate:
+        return "Expired"
+    else:
+        return 'Registered'
+
+
+map_feature = {
+    'Словесный': 'Word',
+    'Изобразительный': 'Figurative',
+    'Комбинированный': 'Combined',
+    'Объемный':  'Three dimensional'
+}
+
+def translate_feature(feature):
+    """translation of mark feature"""
+
+    # needed information from office
+    # if office cannot provide information, then agree on a way to guess (uatm)
+    if not feature: return 'Undefined'
+
+    # out-of-the-box match
+    if feature.capitalize() in std_features:
+        return feature.capitalize()
+
+    translated_feature = map_feature.get(feature, None)
+    if translated_feature:
+        return translated_feature
+
+    # raise Exception to recognize unmapped values
+    raise Exception('Feature "%s" unmapped' % feature)
+

gbdtransformation/brands/kgtm/schema

@@ -0,0 +1,27 @@
+/mark
+__/applicationDate
+__/applicationNumber
+__/expiryDate
+__/goodsServices
+____/item
+______/nice
+______/terms
+________/item
+__/holder
+____/address
+____/countryCode
+____/name
+__/image
+__/kind
+__/markFeature
+__/priorities
+____/item
+______/countryCode
+______/date
+______/number
+__/registrationDate
+__/registrationNumber
+__/registrationOfficeCode
+__/transliteration
+__/type
+__/verbalElement

gbdtransformation/brands/kgtm/template.yml

@@ -0,0 +1,58 @@
+{% from 'navigation.tmpl' import match %}
+
+type: {{ mark.type }}
+kind:
+  - {{ mark.kind | translate_kind}}
+markFeature: {{ mark.markFeature | translate_feature}}
+registrationOfficeCode: {{ mark.registrationOfficeCode}}
+designatedCountries:
+  - {{ mark.registrationOfficeCode}}
+st13: {{ mark.applicationNumber | st13(mark.registrationOfficeCode) }}
+applicationNumber: {{ mark.applicationNumber }}
+applicationDate: {{ mark.applicationDate }}
+registrationNumber: {{ mark.registrationNumber }}
+registrationDate: {{ mark.registrationDate }}
+applicationLanguageCode: ky
+expiryDate: {{ mark.expiryDate }}
+officeStatus: {{ mark.expiryDate | translate_status}}
+gbdStatus: {{ mark.expiryDate | translate_status}}
+statusDate:  {{ mark.registrationDate }}
+wordMarkSpecification:
+  markVerbalElement:
+    - languageCode: {{ mark.verbalElement | guess_language(lang='ky', default='en') }}
+      text: {{mark.verbalElement}}
+  markTransliteration: {{ mark.transliteration }}
+markImageDetails:
+  - name: {{ mark.image }}
+
+goodsServicesClassification:
+  kind: Nice
+  class:
+   {% call(nice) match('goodsServices.item', mark) %}
+    - code: {{ nice.nice | int }}
+      terms:
+        ky:
+        {% call(gsline) match('terms.item', nice) %}
+          - {{ gsline }}
+        {% endcall %}
+   {% endcall %}
+
+priorities:
+  {% call(priority) match('priorities.item', mark) %}
+    - countryCode: {{ priority.countryCode }}
+      number: {{ priority.number}}
+      date: {{ priority.date }}
+  {% endcall %}
+
+applicants:
+    {% if mark.holder.name | has_value %}
+    - fullName:
+        - text: {{ mark.holder.name }}
+          languageCode: ky
+    {% endif %}
+    {% if mark.holder.address | has_value %}
+      fullAddress:
+        - text: {{ mark.holder.address }}
+          languageCode: ky
+    {% endif %}
+      countryCode: {{ mark.holder.countryCode }}

gbdtransformation/brands/khtm/__init__.py

@@ -0,0 +1,14 @@
+render = 'JSON'
+source = 'national'
+
+# KH/1071853A/M # madrid
+# KH/G/2018/5 # gi
+# KH/49703/13 # domestic
+appnum_mask = [ 'KH/(G)/\\d{4}/(.)',
+                'KH/(.*)/(M)',
+                'KH/(.*)/\\d{4}',
+                'KH/(.*)/(\\d{2})']
+
+regnum_mask = [ 'KH/\\d{4}/(\\d*)',
+                'KH/M/(.*)' ]
+