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

gbdtransformation/brands/kztm/filters.py

@@ -0,0 +1,140 @@
+import datetime
+import re
+
+from . import countries
+
+# -------------------------------------------------------------
+# data translation helpers:
+# translate values from office interpretation to gbd equivalent
+# -------------------------------------------------------------
+
+def translate_kind(patent_type):
+    if patent_type == 'Коллективный товарный знак': return 'Collective'
+    else: return 'Individual'
+
+
+def translate_feature(doc):
+    patent_type = (doc.patent_type or '').strip()
+    if patent_type == 'Движущийся товарный знак': return 'Motion'
+    if patent_type == 'Звуковой товарный знак': return 'Sound'
+    if patent_type == 'Позиционный товарный знак': return 'Position'
+    if patent_type == 'Товарный знак голографический': return 'Hologram'
+    else:
+        has_word = doc.trademark_name_ru  or doc.trademark_name_en or doc.trademark_name_kz
+        has_image = doc.image == 'yes'
+        if has_word and has_image: return 'Combined'
+        if has_word: return 'Word'
+        if has_image: return 'Figurative'
+
+    return 'Undefined'
+
+# -------------------------------------------------------------
+def deduce_status(edate):
+    if not edate: return 'Ended'
+
+    today = datetime.datetime.today().strftime('%Y-%m-%d')
+
+    if today > edate: return 'Expired'
+    else: return 'Registered'
+
+def get_color_names(colors_claimed):
+    if not colors_claimed: return []
+
+    if not isinstance(colors_claimed, list):
+        colors_claimed = [colors_claimed]
+
+    color_names = []
+    for  cc in colors_claimed:
+        color_names.append(cc.color)
+
+    return color_names
+
+def get_vienna_codes(vclasses):
+    if not vclasses: return []
+
+    if not isinstance(vclasses, list):
+        vclasses = [vclasses]
+
+    codes = []
+    for  vclass in vclasses:
+        code = vclass.class_number
+        if len(code.split('.')) == 3:
+            codes.append(code)
+
+    return codes
+
+def get_goods_services(list_goods_services):
+    if not list_goods_services: return
+
+    nc = list_goods_services['class'] or []
+    gs = list_goods_services['list'] or []
+
+    if not isinstance(nc, list): nc = [nc]
+    if not isinstance(gs, list): gs = [gs]
+
+    # if not len(nc) == len(gs) and len(gs) > 0:
+    #     raise Exception('attention to goods n services')
+
+    nc_gs = {}
+    nc_gs['00'] = [] # holder for nonclassified
+
+    nbmatch = len(nc) == len(gs)
+    for i,code in enumerate(nc):
+        nc_gs[code] = []
+
+    for i,line in enumerate(gs):
+        if not line: continue
+        terms = [l.strip() for l in line.split(';')]
+        #32 класса - безалкогольные напитки;
+        matches = re.findall(r'^0?(\d+) класса - (.*)', line)
+        if len(matches):
+            # split the class number and the rest of the line
+            (cls, line) = matches[0]
+            nc_gs.setdefault(cls, [])
+            nc_gs[cls] += terms
+        else:
+            #02
+            matches = re.findall(r'^0?(\d+)$', line)
+            if len(matches):
+                cls = matches[0]
+                nc_gs.setdefault(cls, [])
+            elif nbmatch:
+                nc_gs[nc[i]] += terms
+            else:
+                nc_gs['00'] += terms
+    return nc_gs
+
+def parse_persons(inid_7_0):
+    if not inid_7_0: return []
+
+    if not isinstance(inid_7_0, list): inid_7_0 = [inid_7_0]
+
+    persons = []
+    for record in inid_7_0:
+        if not record: continue
+        person = {'address': record['address']}
+        name = record.name or ''
+        matches = re.findall(r'^(.*)\(([A-Z]{2})\)$', name)
+        if len(matches):
+            (person['name'], person['country']) = matches[0]
+        else:
+            person['name'] = name
+            person['country'] = country_name2code(record.country)
+        persons.append(person)
+
+    return persons
+
+def country_name2code(name):
+    if not name:
+        return None
+
+    name = name.strip().lower()
+    for code, country in countries.items():
+        if isinstance(country, list):
+            for syn in country:
+                if syn.lower() == name:
+                    return code
+        else:
+            if country.lower() == name:
+                return code
+    raise Exception('[%s] country name is not mapped' % name)

gbdtransformation/brands/kztm/schema

@@ -0,0 +1,36 @@
+/U_ID
+__/application_parties
+____/inid_730
+______/address
+______/country
+______/name
+____/inid_740
+______/name
+__/colors_claimed
+____/color
+____/color_code
+__/id
+__/image
+__/inid_111
+__/inid_151
+__/inid_170
+__/inid_210
+__/inid_220
+__/inid_270
+__/inid_450
+__/list_of_goods_and_services
+____/class
+____/list
+__/patent_type
+__/priority_info
+____/customer
+______/country
+______/registration_date
+______/registration_number
+__/trademark_name_en
+__/trademark_name_kz
+__/trademark_name_ru
+__/vienne_classification
+____/class
+______/class_description
+______/class_number

gbdtransformation/brands/kztm/template.yml

@@ -0,0 +1,117 @@
+{% from 'navigation.tmpl' import match %}
+
+type: TRADEMARK
+kind:
+  - {{ U_ID.patent_type | translate_kind }}
+markFeature: {{ U_ID | translate_feature }}
+
+registrationOfficeCode: KZ
+designatedCountries:
+  - KZ
+
+st13: {{ U_ID.inid_210 | st13('KZ', appdate=U_ID.inid_220) }}
+
+applicationNumber: {{ U_ID.inid_210 }}
+applicationDate:  {{ U_ID.inid_220 }}
+registrationNumber: {{ U_ID.inid_111 }}
+registrationDate: {{ U_ID.inid_151 }}
+
+applicationLanguageCode: ru
+
+expiryDate: {{ U_ID.inid_170 }}
+
+# rarely passed
+terminationDate:
+
+{% set status = U_ID.inid_170 | deduce_status %}
+officeStatus: {{ status }}
+gbdStatus:  {{ status }}
+
+wordMarkSpecification:
+  markVerbalElement:
+    {% if U_ID.trademark_name_ru %}
+    - languageCode: ru
+      text: {{ U_ID.trademark_name_ru }}
+    {% endif %}
+    {% if U_ID.trademark_name_kz %}
+    - languageCode: kz
+      text: {{ U_ID.trademark_name_kz }}
+    {% endif %}
+    {% if U_ID.trademark_name_en and not U_ID.trademark_name_en == U_ID.trademark_name_ru %}
+    - languageCode: en
+      text: {{ U_ID.trademark_name_en }}
+    {% endif %}
+
+{% if U_ID.image == 'yes' %}
+{% set color_names = U_ID.colors_claimed | get_color_names %}
+{% set vienna_codes = U_ID.vienne_classification.class | get_vienna_codes %}
+markImageDetails:
+  - name: {{ U_ID.inid_210 }}
+    colourIndicator: {{ U_ID.colors_claimed | get_true_or_false }}
+    colourClaimed:
+    {% for cname in color_names %}
+      - languageCode: {{ cname | guess_language('ru') }}
+        text: {{ cname }}
+    {% endfor %}
+
+    {% if (vienna_codes | length) > 0 %}
+    classification:
+      kind: Vienna
+      version: {{ ASK_THE_OFFICE }}
+      code:
+      {% for code in vienna_codes %}
+        - {{ code }}
+      {% endfor %}
+    {% endif %}
+{% endif %}
+
+{% set gs = U_ID.list_of_goods_and_services | get_goods_services %}
+{% if (gs.keys() | length) > 0%}
+goodsServicesClassification:
+  kind: Nice
+  version: {{ ASK_THE_OFFICE }}
+  class:
+  {% for nc in gs.keys() %}
+  {% if not nc == '00' %}
+    - code: {{ nc | int }}
+      terms:
+        ru:
+          {% for term in gs[nc] %}
+          - {{ term }}
+          {% endfor %}
+  {% endif %}
+  {% endfor %}
+{% endif %}
+
+goodsServicesUnclassified:
+  ru:
+    {% for term in gs['00'] or [] %}
+    - {{ term }}
+    {% endfor %}
+
+{% set applicants = U_ID.application_parties.inid_730 | parse_persons %}
+applicants:
+  {% for applicant in applicants %}
+  - fullName:
+      - languageCode: ru
+        text: {{ applicant.name }}
+    fullAddress:
+      - languageCode: {{ applicant.address | guess_language('ru') }}
+        text: {{ applicant.address }}
+    countryCode: {{ applicant.country }}
+  {% endfor %}
+
+{% set representatives = U_ID.application_parties.inid_740 | parse_persons %}
+representatives:
+  {% for representative in representatives %}
+  - fullName:
+      - languageCode: ru
+        text: {{ representative.name }}
+    fullAddress:
+      - languageCode: {{ representative.address | guess_language('ru') }}
+        text: {{ representative.address }}
+    countryCode: {{ representative.country }}
+  {% endfor %}
+
+extra:
+  id: {{ U_ID.id }}

gbdtransformation/brands/latm/__init__.py

@@ -0,0 +1,7 @@
+render = 'JSON'
+source = 'national'
+
+# M/1421805
+# 11858
+appnum_mask = [ '(M)/(\\d*)',
+                '(\\d*)' ]

gbdtransformation/brands/latm/filters.py

@@ -0,0 +1,93 @@
+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 == 'Trademark': return 'TRADEMARK'
+    if code == 'Trademark - Individual': return 'TRADEMARK'
+    if code == 'Trademark - Madrid': return 'TRADEMARK'
+    if code == 'Trademark - Collective': return 'TRADEMARK'
+
+    raise Exception('Type "%s" is not mapped.' % code)
+
+def translate_kind(trademark, header):
+    code = header.TransactionCode
+    subcode = header.TransactionSubCode
+
+    if subcode == 'Trademark': return ['Individual']
+    if subcode == 'TM Individual': return ['Individual']
+    if subcode == 'TM Individual - Renewal': return ['Individual']
+    if subcode == 'Trademark - Madrid': return ['Individual']
+
+    if subcode == 'Collective Mark': return ['Collective']
+    if subcode == 'TM Collective - Renewal': return ['Collective']
+    if subcode == 'Certification Mark': return ['Certificate']
+
+    raise Exception('Kind "%s" not mapped.' % subcode)
+
+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)
+
+# ---------------------------------------
+
+# TODO: language code in data is la (wrong X)
+#       language code for Lao is lo (la is Latin)
+# {'la': ['FAB POWER PLUS IN THAI']} <- en
+# {'la': ['ທະວີໂຊກ ພ້ອມດ້ວຍຮູບ']} <- lo
+def verbal_lang_map(markVerbalElements, applang=None):
+    # print( ipas.verbal_lang_map(markVerbalElements, applang=applang))
+    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
+
+    # no way to deduce registration number
+    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 == 'Trademark - Madrid'
+
+# M/1350065
+def get_ir_refnum(appnum):
+    return appnum.split('/')[-1]
+
+def get_goods_services(goods_services):
+    return ipas.get_goods_services(goods_services)

gbdtransformation/brands/latm/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/latm/template.yml

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

gbdtransformation/brands/latm/tests/test.xml

@@ -0,0 +1,112 @@
+<?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>T</TransactionIdentifier>
+      <TransactionCode>Trademark</TransactionCode>
+      <TransactionSubCode>Trademark</TransactionSubCode>
+      <TransactionData>
+        <TradeMarkApplication>
+          <TradeMarkDetails>
+            <TradeMark>
+              <RegistrationOfficeCode>LA</RegistrationOfficeCode>
+              <ApplicationNumber>37978</ApplicationNumber>
+              <ApplicationDate>2016-08-17</ApplicationDate>
+              <RegistrationNumber>38524</RegistrationNumber>
+              <RegistrationDate>2017-08-15</RegistrationDate>
+              <ApplicationLanguageCode>la</ApplicationLanguageCode>
+              <ExpiryDate>2027-08-15</ExpiryDate>
+              <MarkCurrentStatusDate>2017-08-15</MarkCurrentStatusDate>
+              <MarkFeature>Word</MarkFeature>
+              <MarkImageDetails>
+                <MarkImage/>
+              </MarkImageDetails>
+              <GoodsServicesDetails>
+                <GoodsServices>
+                  <ClassDescriptionDetails>
+                    <ClassDescription>
+                      <ClassNumber>9</ClassNumber>
+                      <GoodsServicesDescription languageCode="la">Electric wires; electric cables; telephone wires; fiber cables; cnamclcd wircs.</GoodsServicesDescription>
+                    </ClassDescription>
+                  </ClassDescriptionDetails>
+                </GoodsServices>
+              </GoodsServicesDetails>
+              <PublicationDetails>
+                <Publication>
+                  <PublicationIdentifier>37978</PublicationIdentifier>
+                  <PublicationDate>2017-09-30</PublicationDate>
+                </Publication>
+              </PublicationDetails>
+              <ApplicantDetails>
+                <Applicant>
+                  <ApplicantAddressBook>
+                    <FormattedNameAddress>
+                      <Name>
+                        <FreeFormatName>
+                          <FreeFormatNameDetails>
+                            <FreeFormatNameLine languageCode="la">TA YA ELECTRIC WIRE &amp; CABLE CO., LTD.</FreeFormatNameLine>
+                          </FreeFormatNameDetails>
+                        </FreeFormatName>
+                      </Name>
+                      <Address>
+                        <AddressCountryCode>TW</AddressCountryCode>
+                        <FreeFormatAddress>
+                          <FreeFormatAddressLine>249, Section 2, Chung Shan Road, Guanmiao District, Tainan City, Taiwan, R.O.C.</FreeFormatAddressLine>
+                        </FreeFormatAddress>
+                      </Address>
+                    </FormattedNameAddress>
+                  </ApplicantAddressBook>
+                </Applicant>
+              </ApplicantDetails>
+              <RepresentativeDetails>
+                <Representative>
+                  <RepresentativeAddressBook>
+                    <FormattedNameAddress>
+                      <Name>
+                        <FreeFormatName>
+                          <FreeFormatNameDetails>
+                            <FreeFormatNameLine languageCode="la">LAO TRADEMARK AGENCY (LAO IP AGENCY)</FreeFormatNameLine>
+                          </FreeFormatNameDetails>
+                        </FreeFormatName>
+                      </Name>
+                      <Address>
+                        <AddressCountryCode>LA</AddressCountryCode>
+                        <FreeFormatAddress>
+                          <FreeFormatAddressLine>LLC Bldg, Nongbone Road, Ban Nongbone, Saysettha District, P.O.BOX 925, Vientiane, LAO P.D.R.</FreeFormatAddressLine>
+                        </FreeFormatAddress>
+                      </Address>
+                    </FormattedNameAddress>
+                  </RepresentativeAddressBook>
+                </Representative>
+              </RepresentativeDetails>
+              <wo:WordMarkSpecification>
+                <wo:MarkVerbalElementText languageCode="la">TA YA</wo:MarkVerbalElementText>
+              </wo:WordMarkSpecification>
+              <wo:MarkEventDetails>
+                <wo:MarkEvent>
+                  <wo:MarkEventDate>2016-08-17</wo:MarkEventDate>
+                  <wo:MarkEventCode>Filed</wo:MarkEventCode>
+                  <wo:OfficeSpecificMarkEventName>Filing</wo:OfficeSpecificMarkEventName>
+                </wo:MarkEvent>
+                <wo:MarkEvent>
+                  <wo:MarkEventDate>2017-08-15</wo:MarkEventDate>
+                  <wo:MarkEventCode>Registered</wo:MarkEventCode>
+                  <wo:OfficeSpecificMarkEventName>Registration</wo:OfficeSpecificMarkEventName>
+                  <wo:OfficeSpecificMarkEventCode>016</wo:OfficeSpecificMarkEventCode>
+                  <wo:OfficeSpecificMarkEventDescription languageCode="la">(TM) Registered</wo:OfficeSpecificMarkEventDescription>
+                </wo:MarkEvent>
+                <wo:MarkEvent>
+                  <wo:MarkEventDate>2017-09-30</wo:MarkEventDate>
+                  <wo:MarkEventCode>Published</wo:MarkEventCode>
+                  <wo:OfficeSpecificMarkEventName>Publication</wo:OfficeSpecificMarkEventName>
+                </wo:MarkEvent>
+              </wo:MarkEventDetails>
+              <wo:MarkCurrentStatusCode>Registered</wo:MarkCurrentStatusCode>
+            </TradeMark>
+          </TradeMarkDetails>
+        </TradeMarkApplication>
+      </TransactionData>
+    </TransactionContentDetails>
+  </TradeMarkTransactionBody>
+</Transaction>

gbdtransformation/brands/lktm/__init__.py

@@ -0,0 +1,5 @@
+render = 'JSON'
+source = 'national'
+
+# AE/321890
+appnum_mask = 'LK/T/1/(\\d*)'

gbdtransformation/brands/lktm/filters.py

@@ -0,0 +1,83 @@
+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 ipas.get_appdate(appdate, appnum)
+
+def translate_type(header):
+    code = header.TransactionCode
+    if code == 'Trademark': return 'TRADEMARK'
+    if code == 'Certification Trademark': return 'TRADEMARK'
+    return 'TRADEMARK'
+
+def translate_kind(trademark, header):
+    subcode = header.TransactionSubCode
+    if subcode == 'Individual Trademark': return ['Individual']
+    if subcode == 'Company/Partnership Trademark': return ['Individual']
+    if subcode == 'Collective Trademark':  return ['Collective']
+    if subcode == 'Certification Trademark':  return ['Individual']
+
+
+    # it is None for all
+    # kind = trademark.KindMark
+
+    raise Exception('Kind "%s" not mapped.' % subcode)
+    return ['Individual']
+
+def translate_status(trademark):
+    status = trademark.MarkCurrentStatusCode
+
+    if status == 'Converted': return 'Registered'
+
+    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):
+    if not event: return 'Unknown'
+
+    return ipas.translate_event(event)
+
+# ---------------------------------------
+# # language code is not accurate for markVerbalElement
+# def guess_language(text, lang, default):
+#     if commons.is_latin(text):
+#         return 'en'
+#     else:
+#         return commons.guess_language(text, lang, default)
+
+# TODO: separate values like
+# {'ar': ['BITUTAPE - بيتوتيب']}
+# {'ar': ['ديمه كابيتال Dimah Capital']}
+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):
+    return False
+
+def get_ir_refnum(appnum):
+    return
+
+def get_goods_services(goods_services):
+    return ipas.get_goods_services(goods_services)