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

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

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

gbdtransformation/brands/bztm/__init__.py

@@ -0,0 +1,16 @@
+render = 'JSON'
+source = 'national'
+
+# TN/M/100/901864 # madrid
+# TN/E/2002/001864 # etrangere
+# TN/T/2019/001877 # local
+# TN/S/2005/001886
+appnum_mask = [ 'BZ/M/\\d*/(\\d*)',
+                'A/T/\\d*/(\\d*)'
+                ]
+
+# 100/901864
+# 2009/002484
+# 001818
+regnum_mask = [ '\\d*/(\\d*)',
+                '(\\d*)' ]

gbdtransformation/brands/bztm/filters.py

@@ -0,0 +1,77 @@
+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].zfill(4)
+
+
+def translate_type(header):
+    code = header.TransactionCode
+
+    if code == 'Trademark': return 'TRADEMARK'
+    if code == 'TM Madrid': return 'TRADEMARK'
+
+    raise Exception('Type "%s" is not mapped.' % code)
+
+def translate_kind(trademark, header):
+    subcode = header.TransactionSubCode
+
+    if subcode == 'Trademark': return ['Individual']
+    if subcode == 'Madrid Protocol': return ['Individual']
+
+    raise Exception('Kind "%s" not mapped.' % subcode)
+
+def translate_status(trademark):
+    status = trademark.MarkCurrentStatusCode
+
+    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: separate values like
+# {'fr': ['PICO BELLO بيكوبالو']}
+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
+
+    # a way to deduce the registration number
+    appnum_parts = trademark.ApplicationNumber.split('/')
+    regnum = '%s/%s' % (appnum_parts[-2], appnum_parts[-1])
+    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(header):
+    code = header.TransactionCode
+    return code == 'Marque Madrid'
+
+# TN/M/100/673426
+def get_ir_refnum(appnum):
+    return appnum.split('/')[-1]
+
+def get_goods_services(goods_services):
+    return ipas.get_goods_services(goods_services)

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

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

gbdtransformation/brands/catm/__init__.py

@@ -0,0 +1,10 @@
+# instruction to render the output to JSON format
+render = 'JSON'
+source = 'national'
+
+# 1501818-00
+# 1501818-01 # only retain version when it is
+             # different that 00
+appnum_mask = [ '(\\d*)-00',
+                '(\\d*)-(\\d{2})',
+                '(\\d*)$']

gbdtransformation/brands/catm/filters.py

@@ -0,0 +1,272 @@
+# standard gbd definitions
+from gbdtransformation.brands import features as std_features
+from gbdtransformation.brands.filters import st13 as std_st13
+import re 
+from datetime import datetime
+# namespaces defined in XML and to be ignored in procecssing
+ignore_namespace = ['http://www.cipo.ic.gc.ca/standards/XMLSchema/ST96/Trademark',
+                    'http://www.wipo.int/standards/XMLSchema/ST96/Common',
+                    'http://www.wipo.int/standards/XMLSchema/ST96/Trademark',
+                    'http://www.cipo.ic.gc.ca/standards/XMLSchema/ST96/Common',
+                    'http://www.w3.org/2001/XMLSchema',
+                    'http://www.oasis-open.org/tables/exchange/1.0',
+                    'http://www.w3.org/1998/Math/MathML',
+                    'http://www.w3.org/2001/XMLSchema-instance']
+
+# -------------------------------------------------------------
+# data translation helpers:
+# translate values from office interpretation to gbd equivalent
+# -------------------------------------------------------------
+
+def to_appnum(appnum):
+    # remove leading 2 numbers
+    appnum = appnum[2:]
+    # remove leading zeros
+    while appnum[0] == '0':
+        appnum = appnum[1:]
+
+    version = appnum[-2:]
+    appnum = appnum[:-2]
+
+    return '%s-%s' % (appnum, version)
+
+def neutralize_version(appnum):
+    if appnum.endswith('-00'):
+        return appnum.replace('-00', '')
+    else: 
+        return appnum
+
+def has_extension_version(name):
+    if name is None: 
+        return False
+    name = name.replace(".png", "")
+    if re.search(r'\-\d\d$', name):
+        return True
+    else: 
+        return False
+
+def get_type_kind(type_raw):
+
+    translations = {
+        'Certification Mark': {
+            'type': 'TRADEMARK',
+            'kind': 'Certificate'
+        },
+        'Denomination': {
+            'type': 'TRADEMARK',
+            'kind': 'Collective'
+        },
+        'Distinguishing Guise': {
+            'type': 'TRADEMARK',
+            'kind': 'Individual'
+        },
+        'General Mark': {
+            'type': 'TRADEMARK',
+            'kind': 'Individual'
+        },
+        'Geographical Indication': {
+            'type': 'GI',
+            'kind': 'Other'
+        },
+        'Mark protected by an Act respecting the Royal Canadian Legion': {
+            'type': 'TRADEMARK',
+            'kind': 'Collective'
+        },
+        'Mark Protected by Federal Act of Incorporation': {
+            'type': 'TRADEMARK',
+            'kind': 'Collective'
+        },
+        'Prohibited Mark; Abbreviation of the Name': {
+            'type': 'EMBLEM',
+            'kind': 'Abbreviation'
+        },
+        'Prohibited Mark; Armorial Bearings': {
+            'type': 'EMBLEM',
+            'kind': 'State emblem'
+        },
+        'Prohibited Mark; Arms, Crest or Emblem': {
+            'type': 'EMBLEM',
+            'kind': 'Armorial bearings'
+        },
+        'Prohibited Mark; Arms, Crest or Flag': {
+            'type': 'EMBLEM',
+            'kind': 'Armorial bearings'
+        },
+        'Prohibited Mark; Badge, Crest, Emblem or Mark': {
+            'type': 'EMBLEM',
+            'kind': 'Armorial bearings'
+        },
+        'Prohibited Mark; Emblem': {
+            'type': 'EMBLEM',
+            'kind': 'Emblem'
+        },
+        'Prohibited Mark; Flag': {
+            'type': 'EMBLEM',
+            'kind': 'Flag'
+        },
+        'Prohibited Mark; Name': {
+            'type': 'EMBLEM',
+            'kind': 'Name'
+        },
+        'Prohibited Mark; Official Mark': {
+            'type': 'EMBLEM',
+            'kind': 'Official sign'
+        },
+        'Prohibited Mark; Official Sign or Hallmark': {
+            'type': 'EMBLEM',
+            'kind': 'Official sign'
+        },
+        'Specific Mark': {
+            'type': 'TRADEMARK',
+            'kind': 'Individual'
+        },
+        'Standardization Mark': {
+            'type': 'TRADEMARK',
+            'kind': 'Individual'
+        },
+        'Trademark': {
+            'type': 'TRADEMARK',
+            'kind': 'Individual'
+        },
+        'Union Label': {
+            'type': 'TRADEMARK',
+            'kind': 'Collective'
+         }
+    }
+    for item in type_raw:
+        if item['_languageCode'] == 'en':
+            res = translations.get(item['__value'], None)
+            if not res:
+                raise Exception('Could not map %s' % type_raw)
+            return res.get('type'), res.get('kind', None)
+
+
+
+def translate_status(trademark):
+    if trademark._operationCategory == 'Delete':
+        return 'Delete'
+
+    status = trademark.MarkCurrentStatusCode
+    if not status: return 'Unknown'
+
+    wipo_statues = {
+        'application filed': 'Pending',
+        'filing date accorded': 'Pending',
+        'classification checked': 'Pending',
+        'application accepted': 'Pending',
+        'application published': 'Pending',
+        'opposition pending': 'Pending',
+        'appeal pending': 'Pending',
+        'action before court of justice pending': 'Pending',
+
+        'revocation proceeding pending': 'Registered',
+        'invalidity proceeding pending': 'Registered',
+        'registration published': 'Registered',
+
+        'application refused': 'Ended',
+        'application withdrawn': 'Ended',
+        'interruption of proceeding': 'Ended',
+        'registration cancelled': 'Ended',
+        'conversion requested': 'Ended',
+        'registration surrendered': 'Ended',
+    }
+
+    res = wipo_statues.get(status.lower(), None)
+
+    # if Registered, check if past expiry date
+    if res == 'Registered':
+        expiry_date = trademark.ExpiryDate
+        if expiry_date:
+            today = datetime.today().strftime("%Y-%m-%d")
+            if expiry_date < today:
+                res = 'Expired'
+
+    if res is not None:
+        return res
+
+    raise Exception('status "%s" is not mapped.' % status)
+
+
+def translate_feature(feature):
+    # if not feature: return 'Undefined'
+    if feature == 'Word': return 'Word'
+    if feature == 'Figurative': return 'Figurative'
+    if feature == 'Combined': return 'Combined'
+    if feature == 'Three dimensional': return 'Three dimensional'
+    if feature == 'Colour': return 'Colour'
+    if feature == 'Sound': return 'Sound'
+    if feature == 'Taste': return 'Taste'
+    if feature == 'Position': return 'Position'
+    if feature == 'Touch': return 'Touch'
+    if feature == 'Motion': return 'Motion'
+    if feature == 'Olfactory': return 'Olfactory'
+    if feature == 'Hologram': return 'Hologram'
+    if feature == 'Other': return 'Other'
+    if feature == 'Design': return 'Combined'
+
+    raise Exception('feature "%s" is not mapped.' % feature)
+    return 'Unknown'
+
+def get_mark_name_from_headings(wspec, trademark):
+    if isinstance(wspec.IndexHeading, list):
+        if len(wspec.IndexHeading) == 0:
+            heading = None
+        else:
+            heading = wspec.IndexHeading[0].IndexHeadingText
+    else:
+        heading = wspec.IndexHeading.IndexHeadingText
+    
+    if heading == None:
+        # fallback to MarkVerbalElementText
+        heading = trademark.MarkRepresentation.MarkReproduction.WordMarkSpecification.MarkVerbalElementText
+        print(heading)
+
+    return heading
+
+def get_mark_names(word_mark_spec):
+    verbal = word_mark_spec.MarkVerbalElementText
+    signif = word_mark_spec.MarkSignificantVerbalElementText
+
+    if not signif == verbal:
+        return signif
+    else:
+        return verbal
+
+def parse_viena(value):
+    return '%s.%s.%s' % (value.ViennaCategory.zfill(2), value.ViennaDivision.zfill(2), value.ViennaSection.zfill(2))
+
+def join_postal(values):
+    if not isinstance(values, list):
+        values = [values]
+
+    return ', '.join([f['__value'] for f in values if f['__value']])
+
+def translate_event(value):
+    wipo_events = {
+        'application filed': 'Filed',
+        'filing date accorded': 'Filed',
+        'classification checked': 'Pending',
+        'application accepted': 'Pending',
+        'application published': 'Published',
+        'opposition pending': 'Opposed',
+        'registration published': 'Registered',
+        'application refused': 'Rejected',
+        'application withdrawn': 'Withdrawn',
+        'appeal pending': 'Appealed',
+        'interruption of proceeding': 'Invalidated',
+        'registration cancelled': 'Withdrawn',
+        'conversion requested': 'Converted',
+        'registration surrendered': 'Withdrawn',
+        'revocation proceeding pending': 'Pending',
+        'invalidity proceeding pending': 'Pending',
+        'action before court of justice pending': 'Awaiting court action',
+        'national prosecution history entry': 'Awaiting court action',
+        'domestic international application history entry': 'Awaiting court action',
+        'national board proceeding history entry': 'Unknown',
+        'national assignment history entry': 'Unknown',
+        'location history entry': 'Unknown'
+    }
+    r = wipo_events.get(value.lower(), None)
+    if r:
+        return r
+    raise Exception('Event "%s" unmapped' % value)