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

gbdtransformation/brands/brtm/filters.py

@@ -0,0 +1,169 @@
+import gbdtransformation.brands.ipas.filters as ipas
+import gbdtransformation.brands.filters as common
+
+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 st13(appnum, office, **args):
+    return common.st13(appnum, office)
+
+def translate_type(header):
+    code = header.TransactionCode
+
+    # extraction missing info.
+    if not code:
+        # defaulting rather than failing...
+        return 'TRADEMARK'
+        #raise Exception('Incomplete Document Info')
+    if code == 'Marca': return 'TRADEMARK'
+    if code == 'Marca Madri': return 'TRADEMARK'
+    """
+    if code == 'National TradeMarks': return 'TRADEMARK'
+    if code == 'Zimbabwe': return 'TRADEMARK'
+    if code == 'Madrid': return 'TRADEMARK'
+    if code == 'Banjul Protocol Marks': return 'TRADEMARK'
+    """
+    return 'TRADEMARK'
+    #raise Exception('Type "%s" is not mapped.' % code)
+
+def translate_kind(trademark, header):
+    subcode = header.TransactionSubCode
+    if subcode == 'Marca de Produto': return ['Individual']
+    if subcode == 'Marca de Serviço': return ['Individual']
+    if subcode == 'Marca Genérica': return  ['Individual']
+    if subcode == 'Marca de Produto/Serviço': return ['Individual']
+    if subcode == 'Madri Produto/Serviço': return ['Individual']
+    if subcode == 'Madri Coletiva': return ['Collective']
+    if subcode == 'Marca Coletiva': return ['Collective']
+    if subcode == 'Marca de Propaganda': return ['Individual']
+    if subcode == 'Marca de Certificação': return ['Certificate']
+    if subcode == 'Madri Certificação': return ['Certificate']
+    """
+    if subcode == 'Marca de Certificação': return ['Certificate']
+    if subcode == 'Part A': return ['Individual']
+    if subcode == 'Part B': return ['Individual']
+    if subcode == 'Part C': return ['Individual']
+    if subcode == 'Part D': return ['Individual']
+    if subcode == 'National Trademarks': return ['Individual']
+    if subcode == 'Madrid Protocol': return ['Individual']
+    if subcode == 'Banjul Protocol Marks': return ['Individual']
+    """
+    return ['Undefined']
+    #raise Exception('Kind "%s" not mapped.' % subcode)
+
+def translate_status(trademark):
+    status = trademark.MarkCurrentStatusCode
+    if status in ['Registrado']: return 'Registered'
+    if status in ['Expirado']: return 'Expired'
+    if status in ['Recorrido','Examinado', 'Publicado','Oposto', 'Pendente', 'Sub judice', 'Sobrestado']: return 'Pending'
+    if status in ['Abandonado/arquivado', 'Depositado', 'Anulado','Indeferido']: return 'Ended'
+
+    if status == 'Inativo':
+        if trademark.ExpiryDate: return 'Expired'
+        else: return 'Ended'
+
+    if status == "662":
+        # "Verificando o pagamento da concessão (encerrado o prazo extraordinário)"
+        return "Pending"
+
+    if status == "663":
+        # ?
+        return "Unknown"
+
+    if status == "687":
+        # "Designação de Madri aguardando processamento de DEATH CPN"
+        return "Pending"
+
+    #raise Exception('status "%s" not mapped.' % status)
+    return ipas.translate_status(status)
+
+def parseStatus(status):
+    if status == 'Depositado': return "Filed"
+    if status == 'Publicado': return "Published"
+    if status == 'Oposto': return "Opposed"
+    if status == 'Registrado': return "Registered"
+    if status == 'Indeferido': return "Rejected"
+    if status == 'Desistido': return "Withdrawn"
+    if status == 'Recorrido': return "Appealed"
+    if status == 'Sobrestado': return "Suspended"
+    if status == 'Abandonado/arquivado': return "Abandoned"
+    if status == 'Convertido': return "Converted"
+    if status == 'Renunciado': return "Surrendered"
+    if status == 'Anulado': return "Invalidated"
+    if status == 'Sub judice': return "Awaiting Court Action"
+    if status == 'Examinado': return "Examined"
+    if status == 'Expirado': return "Expired"
+    if status == 'Reinstado': return "Reinstated"
+    if status == 'Inativo': return "Inactive"
+    if status == 'Pendente': return "Pending"
+    return 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'
+
+# IB/D/1/1020123
+def get_ir_refnum(appnum):
+    return appnum.split('/')[-1]
+
+def parse_version(version):
+    return None
+def get_goods_services(goods_services, nice_only = True):
+    nc_gs = {}  # classified
+    if not goods_services:
+        goods_services = []
+
+    if not isinstance(goods_services, list):
+        goods_services = [goods_services]
+
+    for goods_service in goods_services:
+        code = goods_service.ClassNumber
+        if code and not code == '0' and (not nice_only and int(code) >= 110 or int(code) <= 45 and nice_only):
+            nc_gs[code] = {}
+            desc = goods_service.GoodsServicesDescription
+
+            if hasattr(desc, '__value'):
+                terms = desc.__value
+            else:
+                terms = desc
+
+            if terms:
+                nc_gs[code]['terms'] = terms
+            else:
+                continue
+
+            if hasattr(desc, '_languageCode'):
+                lang = desc._languageCode
+                nc_gs[code]['lang'] = lang.lower()
+    return nc_gs

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

@@ -0,0 +1,22 @@
+{% include "ipas/template.yml" %}
+{% from 'navigation.tmpl' import match %}
+{% call(header) match('TradeMarkTransactionBody.TransactionContentDetails', Transaction) %}
+{% call(trademark) match('TransactionData.TradeMarkApplication.TradeMarkDetails.TradeMark', header) %}
+{% set nc_gs = trademark.GoodsServicesDetails.GoodsServices.ClassDescriptionDetails.ClassDescription | get_goods_services(nice_only=False) %}
+{% if (nc_gs.keys() | length) > 0 %}
+nationalGoodsServicesClassification:
+  kind: INPI
+  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 %}
+{% endcall %}
+{% endcall %}

gbdtransformation/brands/brtm/tests/test01.xml

@@ -0,0 +1,53 @@
+<?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></TransactionIdentifier>
+      <TransactionCode></TransactionCode>
+      <TransactionSubCode></TransactionSubCode>
+      <TransactionData>
+        <TradeMarkApplication>
+          <TradeMarkDetails>
+            <TradeMark>
+              <RegistrationOfficeCode>BR</RegistrationOfficeCode>
+              <ApplicationNumber>MMA1501730141</ApplicationNumber>
+              <ApplicationDate></ApplicationDate>
+              <ApplicationLanguageCode>pt</ApplicationLanguageCode>
+              <MarkImageDetails>
+                <MarkImage/>
+              </MarkImageDetails>
+              <PublicationDetails>
+                <Publication>
+                  <PublicationIdentifier>MMA1501730141</PublicationIdentifier>
+                  <PublicationDate>2023-12-12</PublicationDate>
+                </Publication>
+              </PublicationDetails>
+              <ApplicantDetails>
+                <Applicant>
+                  <ApplicantAddressBook>
+                    <FormattedNameAddress>
+                      <Name>
+                        <FreeFormatName>
+                          <FreeFormatNameDetails>
+                            <FreeFormatNameLine languageCode="pt">Shengqun Zhou</FreeFormatNameLine>
+                          </FreeFormatNameDetails>
+                        </FreeFormatName>
+                      </Name>
+                      <Address>
+                        <AddressCountryCode>CN</AddressCountryCode>
+                      </Address>
+                    </FormattedNameAddress>
+                  </ApplicantAddressBook>
+                </Applicant>
+              </ApplicantDetails>
+              <wo:WordMarkSpecification/>
+              <wo:MarkEventDetails/>
+              <wo:MarkCurrentStatusCode>Depositado</wo:MarkCurrentStatusCode>
+            </TradeMark>
+          </TradeMarkDetails>
+        </TradeMarkApplication>
+      </TransactionData>
+    </TransactionContentDetails>
+  </TradeMarkTransactionBody>
+</Transaction>

gbdtransformation/brands/bttm/__init__.py

@@ -0,0 +1,10 @@
+render = 'JSON'
+source = 'national'
+
+# BT/M/811870 # madrid
+# A/M/807290 # madrid
+# T/2000/1870
+appnum_mask = [ 'BT/(M)/(\\d*)',
+                '([A-Z])/(M)/(\\d*)',
+                'T/\\d{4}/(\\d*)',
+                '(\\d*)' ]

gbdtransformation/brands/bttm/filters.py

@@ -0,0 +1,80 @@
+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):
+    try:
+        return appnum.split('/')[-2].zfill(4)
+    except:
+        return ipas.get_appdate(appdate, appnum)
+
+def translate_type(header):
+    code = header.TransactionCode
+
+    if code == 'National Marks': return 'TRADEMARK'
+    if code == 'Madrid Marks': return 'TRADEMARK'
+    if code == 'Prohibited Marks': return 'TRADEMARK'
+
+    raise Exception('Type "%s" is not mapped.' % code)
+
+def translate_kind(trademark, header):
+    code = header.TransactionCode
+
+    if code == 'National Marks': return ['Individual']
+    if code == 'Madrid Marks': return ['Individual']
+    if code == 'Prohibited Marks': return ['Individual']
+
+    # it is set to Other for all
+    # kind = trademark.KindMark
+
+    raise Exception('Kind "%s" not mapped.' % code)
+
+def translate_status(trademark):
+    status = trademark.MarkCurrentStatusCode
+
+    if status == '3742': return 'Unknown'
+    if status == '3745': 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)
+
+# ---------------------------------------
+
+def verbal_lang_map(markVerbalElements, applang=None):
+    # TOASK: many documents with DUMMY verbal elements
+    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
+
+    return trademark.ApplicationNumber.split('/')[-1]
+
+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 content.TransactionCode == 'Madrid Marks'
+
+def get_ir_refnum(appnum):
+    return appnum.split('/')[-1]
+
+def get_goods_services(goods_services):
+    return ipas.get_goods_services(goods_services)

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

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

gbdtransformation/brands/bwtm/__init__.py

@@ -0,0 +1,13 @@
+render = 'JSON'
+source = 'national'
+
+# MD/D/0/1166434
+# MD/M/1984/8536
+# A/D/1/1018149
+# BW/M/1964/1814
+# BW/D/1971/811
+# AP/M/1997/21
+appnum_mask = [ '([A-C])/([A-Z])/\\d/(\\d*)',
+                'BW/([A-Z])/\\d{4}/(\\d*)',
+                '[A-Z]{2}/(M|D)/\\d{1,4}/(\\d*)',
+                '[A-Z]{2}/(B)/(\\d{4})/(\\d*)' ]

gbdtransformation/brands/bwtm/filters.py

@@ -0,0 +1,90 @@
+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)
+
+# 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)
+
+def translate_type(header):
+    code = header.TransactionCode
+
+    if code == 'National Marks': return 'TRADEMARK'
+    if code == 'Madrid Marks': return 'TRADEMARK'
+    if code == 'Banjul Protocol Marks': return 'TRADEMARK'
+
+    raise Exception('Type "%s" is not mapped.' % code)
+
+def translate_kind(trademark, header):
+    code = header.TransactionCode
+
+    if code == 'National Marks': return ['Individual']
+    if code == 'Madrid Marks': return ['Individual']
+    if code == 'Banjul Protocol Marks': return ['Individual']
+
+    # it is set to Other for all
+    # kind = trademark.KindMark
+
+    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
+
+    if not tmstatus in ['Expired', 'Registered']:
+        return None
+
+    # BW/M/2011/815 -> 2011000815
+    appnum_parts = trademark.ApplicationNumber.split('/')
+    appyear = appnum_parts[-2]
+    appnum  = appnum_parts[-1]
+    regnum = '%s%s' %(appyear, appnum.zfill(6))
+    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)
+
+def is_international(content):
+    return content.TransactionCode == 'Madrid Marks'
+
+def get_ir_refnum(appnum):
+    return appnum.split('/')[-1]
+
+def get_goods_services(goods_services):
+    return ipas.get_goods_services(goods_services)