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

gbdtransformation/brands/woao/filters.py

@@ -0,0 +1,107 @@
+# standard gbd definitions
+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
+from datetime import datetime
+# namespaces defined in XML and to be ignored in procecssing
+ignore_namespace = []
+
+def get_type(lisbon):
+    return lisbon.NUMBER._KIND
+
+def get_names(names):
+    joined = []
+    if not isinstance(names, list):
+        names = [names]
+    for name in names:
+        joined.append(name)
+
+    return ' / '.join(joined)
+
+def get_gbd_status(status):
+    if status == 'A': return 'Registered'
+    if status == 'C': return 'Ended'
+
+    raise Exception('Status %s not mapped' % status)
+
+def get_office_status(status):
+    if status == 'A': return 'Active'
+    if status == 'C': return 'Cancelled'
+
+def get_st13_lisbon(lisbon, appdate):
+    # remove special characters
+
+    appnum = lisbon.NUMBER['__value']
+    if not appnum:
+        raise Exception("No appnumber provided")
+    if not appdate:
+        appdate = '0000'
+    return 'WO81%s%s' % (appdate[:4], appnum.zfill(9))
+
+def get_pub(lisbon):
+    pub = lisbon.PUB
+    if pub:
+        if ':' in pub:
+            tmp = pub.split(':')
+            try:
+                date = datetime.strptime(tmp[1].strip(), "%U/%Y")
+                date = date.strftime('%Y-%m-%d')
+            except:
+                date = None
+            return tmp[0].replace('N\u00b0', '').strip(), date
+        return pub.replace('N\u00b0', '').strip(), None
+    return None, None
+
+def get_events(lisbon):
+    types = [{
+        'key': 'REFUSALGR',
+        'gbd_type': 'Rejected',
+        'type': 'Refusal'
+    },
+        {
+            'key': 'MODIFICATIONGR',
+            'gbd_type': 'Published',
+            'type': 'Modification'
+        },
+        {
+            'key': 'WITHDGR',
+            'gbd_type': 'Withdrawn',
+            'type': 'Withdrawal'
+        },
+        {
+            'key': 'GRANTGR',
+            'gbd_type': 'Registered',
+            'type': 'Grant'
+        },
+        {
+            'key': 'RENUNCIATION_RULE16GR',
+            'gbd_type': 'Ended',
+            'type': 'Cancelled'
+        },
+    ]
+    to_return = []
+    for ttype in types:
+        events = lisbon.get(ttype['key'], [])
+        if not isinstance(events, list):
+            events = [events]
+        for event in events:
+            ev_key = list(event.keys())[0]
+            sub_events = event[ev_key]
+            if not isinstance(sub_events, list):
+                sub_events = [sub_events]
+            for tmp in sub_events:
+                pdf = tmp.get('PDF', None)
+                to_return.append({
+                    'kind': ttype['type'],
+                    'gbd_kind': ttype['gbd_type'],
+                    'date': tmp.get('DATE', None),
+                    'country': tmp.get('CC', None),
+                    'extra': pdf
+                })
+    return to_return
+
+def to_link(val):
+    if val:
+        return 'https://www.wipo.int/ipdl/jsp/data.jsp?TYPE=PDF&SOURCE=LISBON&KEY=' + val
+    return None

gbdtransformation/brands/woao/schema

@@ -0,0 +1,116 @@
+/LISBON
+__/APPGR
+____/APP
+__/APPWAGR
+____/APP
+__/AREAGR
+____/AREA
+____/AREA[@LANG=EN]
+____/AREA[@LANG=ES]
+____/AREA[@LANG=FR]
+__/CANCELLATION
+____/PDF
+__/CATEGORYGR
+____/SUB-CAT
+__/CATEGORYGR[@ID=BEV]
+__/CATEGORYGR[@ID=DAIRY]
+__/CATEGORYGR[@ID=FOOD]
+__/CATEGORYGR[@ID=FRUITS]
+__/CATEGORYGR[@ID=MEAT]
+__/CATEGORYGR[@ID=NONFOOD]
+__/CATEGORYGR[@ID=TEXTILE]
+__/CATEGORYGR[@ID=VEGE]
+__/CATEGORYGR[@ID=WINES]
+__/COO
+____/CC
+__/GENEVEACT
+__/GENEVE_ACT
+____/CC
+__/GRANTGR
+____/GRANT
+______/CC
+______/DATE
+______/PDF
+__/HOLGR
+____/HOL
+____/HOL[@LANG=EN]
+____/HOL[@LANG=ES]
+____/HOL[@LANG=FR]
+__/INVGR
+____/INV
+______/CC
+______/DATE
+______/PDF
+__/LEGALGR
+____/LEGAL
+______/TEXT
+____/LEGAL[@LANG=EN]
+____/LEGAL[@LANG=ES]
+____/LEGAL[@LANG=FR]
+__/LISBONACT
+__/MODIFICATIONGR
+____/MODIFICATION
+______/DATE
+______/MOD_TYPE
+______/PDF
+__/NOTIFICATION
+____/DATE_END_REFUS
+____/DATE_NOTIF
+__/NOTIFICATION_EXCEPTION
+____/NOTIF_EXCEPTION
+______/CP
+______/DATE_ACK
+__/NUMBER
+__/NUMBER[@KIND=AO]
+__/NUMBER[@ORGLANG=EN]
+__/NUMBER[@ORGLANG=ES]
+__/NUMBER[@ORGLANG=FR]
+__/NUMBER[@STATUS=A]
+__/NUMBER[@STATUS=C]
+__/PERIODGR
+____/PERIOD
+______/CC
+______/DATE
+______/PDF
+__/PRODUCTGR
+____/PRODUCT
+____/PRODUCT[@LANG=EN]
+____/PRODUCT[@LANG=ES]
+____/PRODUCT[@LANG=FR]
+__/PUB
+__/REFUSALGR
+____/REFUSAL
+______/CC
+______/DATE
+______/GROUNDS
+________/GROUND
+______/PDF
+____/REFUSAL[@KIND=PARTIAL]
+__/REG
+____/CERTIF
+____/DATE
+__/RENUNCIATION_RULE16GR
+____/RENUNCIATION_RULE16
+______/CC
+______/DATE
+______/PDF
+__/TRANSLATGR
+____/TRANSLAT
+____/TRANSLAT[@LANG=AR]
+____/TRANSLAT[@LANG=CN]
+____/TRANSLAT[@LANG=DE]
+____/TRANSLAT[@LANG=EN]
+____/TRANSLAT[@LANG=ES]
+____/TRANSLAT[@LANG=FR]
+____/TRANSLAT[@LANG=LA]
+____/TRANSLAT[@LANG=PT]
+____/TRANSLAT[@LANG=RU]
+__/TRANSLIT
+__/WITHDGR
+____/WITHD
+______/CC
+______/DATE
+______/DET
+______/GROUNDS
+________/GROUND
+______/PDF

gbdtransformation/brands/woao/template.yml

@@ -0,0 +1,90 @@
+{% from 'navigation.tmpl' import match %}
+
+{% set _space = " " %}
+
+type: {{ LISBON.NUMBER._KIND }}
+kind:
+  - Other
+
+markFeature: Word
+
+registrationOfficeCode: LISBON
+designatedCountries:
+  - XX
+
+reference:
+  office: {{ LISBON.COO.CC }}
+
+st13: {{ LISBON | get_st13_lisbon(LISBON.REG.DATE | convertdate('%d/%m/%Y')) }}
+registrationNumber: {{ LISBON.NUMBER._KIND | append(_space, LISBON.NUMBER.__value) }}
+registrationDate: {{ LISBON.REG.DATE | convertdate('%d/%m/%Y') }}
+applicationLanguageCode: {{ LISBON.NUMBER._ORGLANG | lower}}
+
+officeStatus: {{ LISBON.NUMBER._STATUS | get_office_status }}
+gbdStatus: {{ LISBON.NUMBER._STATUS | get_gbd_status }}
+
+markDisclaimerDetails:
+  {% call(desc) match('LEGAL', LISBON.LEGALGR) %}
+  {% call(tmp) match('TEXT', desc) %}
+  - text: {{ tmp  }}
+    languageCode: {{ tmp | guess_language(desc._LANG) | lower }}
+    {% endcall %}
+  {% endcall %}
+
+wordMarkSpecification:
+  markVerbalElement:
+    - languageCode: {{ LISBON.NUMBER._ORGLANG | lower }}
+      text: {{ LISBON.APPGR.APP | get_names }}
+
+  markTranslation:
+  {% call(verbal) match('TRANSLAT', LISBON.TRANSLATGR) %}
+    - languageCode: {{ verbal | guess_language(verbal._LANG) | lower }}
+      text: {{ verbal }}
+  {% endcall %}
+
+  markTransliteration: {{ LISBON.TRANSLIT }}
+
+goodsServicesUnclassified:
+  {% call(verbal) match('PRODUCT', LISBON.PRODUCTGR) %}
+    {{ verbal._LANG | lower | field_name }}:
+    - {{ verbal }}
+  {% endcall %}
+
+publications:
+  - identifier: {{ LISBON.PUB }}
+
+applicants:
+  - fullName:
+  {% call(HOL) match('HOL', LISBON.HOLGR) %}
+    - text: {{ HOL.__value }}
+      languageCode: {{ HOL.__value | guess_language(HOL._LANG) | lower }}
+  {% endcall %}
+    countryCode: {{ LISBON.COO.CC }}
+
+events:
+  {% for event in LISBON | get_events %}
+  - officeKind: {{ event.kind }}
+    gbdKind: {{ event.gbd_kind }}
+    date: {{ event.date | convertdate('%d.%m.%Y') }}
+    country: {{ event.country }}
+    {% if event.extra %}
+    doc: {{ event.extra | to_link }}
+    {% endif %}
+  {% endfor %}
+
+extra:
+  area:
+  {% call(area) match('AREA', LISBON.AREAGR) %}
+    - text: {{ area.__value }}
+      languageCode: {{ area.__value | guess_language(area._LANG) | lower }}
+  {% endcall %}
+  lisbonact: {{ LISBON.LISBONACT | get_true_or_false }}
+  geneveact: {{ LISBON.GENEVEACT | get_true_or_false }}
+  geneveactcc:
+  {% call (cc) match ('GENEVE_ACT.CC', LISBON)%}
+    - {{ cc }}
+  {% endcall %}
+  cancellationdoc: {{ LISBON.CANCELLATION.PDF }}
+  regdoc: {{ LISBON.REG.CERTIF }}
+  pdf: {{ LISBON.REG.NOTIF | to_link }}
+

gbdtransformation/brands/woptm/__init__.py

@@ -0,0 +1,3 @@
+# instruction to render the output to JSON format
+render = 'JSON'
+source = 'international'

gbdtransformation/brands/woptm/filters.py

@@ -0,0 +1,42 @@
+from gbdtransformation.brands.wotm.filters import *
+
+
+def is_pending(tm):
+    return True
+
+def get_status(tm):
+    if tm.ApplicationNumber:
+        return ('Pending', 'Pending subsequent designation')
+    else:
+        return ('Pending', 'Pending application')
+
+def st13(tm, apprefs, regrefs):
+    appnum = tm['http://www.wipo.int/standards/XMLSchema/trademarks_WO_Pending_Number']
+
+    if len(regrefs):
+        type = 'pending-%s' % ('basicregistrationnumber')
+    # it happens to have pending with no Basic ApplicationNumber/RegistrationNumber (bof)
+    else:
+    # elif len(apprefs):
+        type = 'pending-%s' % ('basicapplicationnumber')
+
+    return std_st13(appnum.replace('PEND', ''), type=type, office='WO', roffice=tm.ReceivingOfficeCode)
+
+def get_application_date(tm):
+    ib_recieving_date = tm.MarkRecordDetails['http://www.wipo.int/standards/XMLSchema/trademarks_WO_IBReceiptDate']
+
+    if(ib_recieving_date):
+        return ib_recieving_date
+
+    raise Exception('could not find IBReceiptDate')
+
+# for pending, get from MarkRecordDetails (subsequent designations)
+def get_designations(tm):
+    try:
+        countries = tm.MarkRecordDetails.DesignatedCountryDetails.DesignatedCountry
+    except:
+        raise Exception('No DesignatedCountryDetails. Do not Import')
+
+    if not isinstance(countries, list):
+        countries = [countries]
+    return countries

gbdtransformation/brands/woptm/template.yml

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

gbdtransformation/brands/wotm/__init__.py

@@ -0,0 +1,3 @@
+# instruction to render the output to JSON format
+render = 'JSON'
+source = 'international'

gbdtransformation/brands/wotm/filters.py

@@ -0,0 +1,127 @@
+import datetime
+import re
+
+from gbdtransformation.brands.filters import st13 as std_st13
+from gbdtransformation.brands.filters import split_vienna as std_split_vienna
+
+# namespaces defined in XML and to be ignored in procecssing
+ignore_namespace = [
+    'http://www.wipo.int/standards/XMLSchema/trademarks'
+]
+
+def split_vienna(code):
+    if not code: return ''
+    if len(code) == 4: code = '%s00' % code
+
+    return std_split_vienna(code)
+
+def translate_kind(kind):
+    if not kind: return ['Individual']
+
+    if kind == 'Individual': return ['Individual']
+    if kind == 'Collective': return ['Collective']
+
+    return ['Other']
+    #raise Exception('kind "%s" is not mapped.' % kind)
+
+def translate_feature(feature):
+    if not feature: return 'Undefined'
+
+    if feature == 'Figurative': return 'Figurative'
+    if feature == 'Word': return 'Word'
+    if feature == '3-D': return 'Three dimensional'
+    if feature == 'Sound': return 'Sound'
+    if feature == 'Colour': return 'Colour'
+    if feature == 'Position': return 'Position'
+
+    return 'Other'
+    #raise Exception('Feature "%s" unmapped' % feature)
+
+def get_entity_kind(entity):
+    if entity.ApplicantLegalEntity: return 'Legal entity'
+    else: return ''
+
+def get_refs(brefs):
+    if not isinstance(brefs, list):
+        brefs = [brefs]
+
+    apprefs = []
+    regrefs = []
+
+    for bref in brefs:
+        if bref.BasicApplicationDetails:
+            zref = bref.BasicApplicationDetails.BasicApplication
+            if(zref.BasicApplicationNumber):
+                apprefs.append({'number': zref.BasicApplicationNumber,
+                                'date':   zref.BasicApplicationDate})
+        if bref.BasicRegistrationDetails:
+            zref = bref.BasicRegistrationDetails.BasicRegistration
+            if zref.BasicRegistrationNumber:
+                regrefs.append({'number': zref.BasicRegistrationNumber,
+                                'date':   zref.BasicRegistrationDate})
+    return (apprefs, regrefs)
+
+def get_entity_name_and_address(adrbook):
+    name_lines = adrbook.Name.FreeFormatName.FreeFormatNameDetails.FreeFormatNameLine
+    try:
+        addr_lines = adrbook.Address.FreeFormatAddress.FreeFormatAddressLine
+    except:
+        addr_lines = []
+
+    if not isinstance(name_lines, list): name_lines = [name_lines]
+    if not isinstance(addr_lines, list): addr_lines = [addr_lines]
+
+    # sometime we have empty tags !
+    name_lines = [n for n in name_lines if n]
+    addr_lines = [n.rstrip(',') for n in addr_lines if n]
+
+    return (', '.join(name_lines), ', '.join(addr_lines))
+
+def get_designations(tm):
+    if tm.DesignatedCountryDetails:
+        countries = tm.DesignatedCountryDetails.DesignatedCountry
+    else:
+        countries = []
+    if not isinstance(countries, list):
+        countries = [countries]
+    return countries
+
+
+def get_designations_madrid(tm):
+    madrid = []
+    madrid96 = []
+    if tm.DesignatedCountryDetails:
+        countries = tm.DesignatedCountryDetails.DesignatedCountry
+        if not isinstance(countries, list):
+            tmp = []
+            tmp.append(countries)
+            countries = tmp
+        for c in countries:
+            if c.get('DesignatedUnderCode') != 'Protocol':
+                madrid96.append(c.DesignatedCountryCode)
+            else:
+                madrid.append(c.DesignatedCountryCode)
+    return madrid, madrid96
+
+
+def get_status(tm):
+    if tm.ExpiryDate:
+        today = datetime.datetime.today().strftime('%Y-%m-%d')
+        if today > tm.ExpiryDate: return ('Expired', 'Expired')
+    # TOASK: no expiry date => Expired ?
+    else:
+        return ('Expired', 'Expired')
+
+    return ('Registered', 'Registered')
+
+def st13(tm, apprefs, regrefs):
+    appnum = tm.ApplicationNumber
+    return std_st13(appnum, office='WO', type='registered', sanitize=False)
+
+def get_application_date(tm):
+    if tm.ApplicationDate and len(tm.ApplicationDate.strip().replace('-', '')):
+        return tm.ApplicationDate
+
+def get_expiry_date(tm):
+    if tm.ExpiryDate and len(tm.ExpiryDate.strip().replace('-', '')):
+        return tm.ExpiryDate