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

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

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

gbdtransformation/brands/attm/__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{4}'
+regnum_mask = '(.*)'

gbdtransformation/brands/attm/filters.py

@@ -0,0 +1,76 @@
+# standard gbd definitions
+from gbdtransformation.brands.filters import st13 as std_st13
+
+# namespaces defined in XML and to be ignored in procecssing
+ignore_namespace = []
+
+def parse_appnum(appnum):
+    return appnum.split('/')
+
+# -------------------------------------------------------------
+# data translation helpers:
+# translate values from office interpretation to gbd equivalent
+# -------------------------------------------------------------
+
+gbd_status_map = {
+    '1': 'Ended',
+    '2': 'Ended',
+    '3': 'Pending',
+    '4': 'Registered',
+    '5': 'Delete'
+}
+off_status_map = {
+    '1': 'Invalid registration',
+    '2': 'Registration aborted',
+    '3': 'In registration',
+    '4': 'Registered',
+    '5': 'Deleted'
+}
+
+def translate_status(status, feature):
+    """translation of mark status"""
+    # a required data from office. if not present and no way to guess,
+    # return Unknown
+    gstatus = gbd_status_map[status]
+
+    # this is an empty document. we will import it as a Delete
+    if gstatus == 'Ended' and feature == 'Undefined':
+        gstatus = 'Delete'
+
+    return (gstatus, off_status_map[status])
+
+map_feature = {
+    'B': 'Figurative',
+    'C': 'Combined',
+    'F': 'Colour',
+    'G': 'Motion',
+    'H': 'Hologram',
+    'K': 'Three dimensional',
+    'L': 'Multimedia',
+    'O': 'Other',
+    'P': 'Position',
+    'S': 'Sound',
+    'W': 'Word',
+    'M': 'Pattern'
+}
+
+
+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'
+
+    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)
+
+def get_name(applicant):
+    return ("%s %s" % (applicant.Vorname, applicant.Name)).replace('None', '').strip()
+
+def get_address(applicant):
+    return ("%s %s %s %s %s" % (applicant.Strasse, applicant.Stiege, applicant.Tuer, applicant.PLZ, applicant.Ort)).replace('None ', '').strip()

gbdtransformation/brands/attm/schema

@@ -0,0 +1,52 @@
+
+/mark
+__/AnmeldeDatum
+__/Anmeldenummer
+__/Applicants
+____/item
+______/Land
+______/Name
+______/Ort
+______/PLZ
+______/PersonenAuswahlId
+______/Personenart
+______/Reihenfolge
+______/Stiege
+______/Strasse
+______/Tuer
+______/Vorname
+__/GoodsAndServices
+____/item
+______/Beschreibung
+______/Klassen
+______/Prioritaet
+______/WarenklasseReihenfolge
+__/MarkenName
+__/Markenart
+__/NationaleMarkeId
+__/Pfad
+__/Priorities
+____/item
+______/PrioDatum
+______/PrioLand
+______/PrioritaetReihenfolge
+______/Prioritaetsnummer
+__/PublikationsDatum
+__/Quelle
+__/RegisterDatum
+__/RegisterNr
+__/Representatives
+____/item
+______/Land
+______/Name
+______/Ort
+______/PLZ
+______/PersonenAuswahlId
+______/Personenart
+______/Reihenfolge
+______/Stiege
+______/Strasse
+______/Tuer
+______/Vorname
+__/Status
+__/Widerspruch

gbdtransformation/brands/attm/template.yml

@@ -0,0 +1,85 @@
+{% from 'navigation.tmpl' import match %}
+
+{% set feature =  mark.Markenart | translate_feature %}
+{% set (gstatus, ostatus) = mark.Status | translate_status(feature) %}
+
+{% set (appnum, appyear) = mark.Anmeldenummer | parse_appnum %}
+
+
+st13: {{ mark.Anmeldenummer | st13("AT", appdate=appyear) }}
+registrationOfficeCode: AT
+type: TRADEMARK
+gbdStatus: {{ gstatus }}
+
+{% if not gstatus == 'Delete' %}
+
+kind:
+  - Individual
+markFeature: {{ feature }}
+designatedCountries:
+  - AT
+
+applicationNumber: {{ mark.Anmeldenummer }}
+applicationDate: {{ mark.AnmeldeDatum | convertdate('%d.%m.%Y') }}
+publicationDate: {{ mark.PublikationsDatum | convertdate('%d.%m.%Y') }}
+registrationNumber: {{ mark.RegisterNr }}
+registrationDate: {{ mark.RegisterDatum | convertdate('%d.%m.%Y') }}
+applicationLanguageCode: de
+officeStatus: {{ ostatus }}
+statusDate: {{ mark.PublikationsDatum | convertdate('%d.%m.%Y')}}
+wordMarkSpecification:
+  markVerbalElement:
+    - languageCode: {{ mark.MarkenName | guess_language('de') }}
+      text: {{ mark.MarkenName }}
+markImageDetails:
+  - name: {{ mark.Pfad}}
+
+{% call(nc_gs) match('GoodsAndServices', mark) %}
+goodsServicesClassification:
+  kind: Nice
+  version: {{ ASK_THE_OFFICE }}
+  class:
+  {% call(nice) match('item', nc_gs) %}
+  - code: {{ nice.Klassen | int }}
+    terms:
+      {% call(gs) match('Beschreibung', nice) %}
+      de:
+      {% for gsline in gs | remove_trailing('.') | lower | split_terms %}
+        - {{ gsline }}
+      {% endfor %}
+      {% endcall %}
+   {% endcall %}
+{% endcall %}
+
+priorities:
+  {% call(priority) match('Priorities.item', mark) %}
+    - countryCode: {{ priority.PrioLand }}
+      number: {{ priority.Prioritaetsnummer}}
+      date: {{ priority.PrioDatum | convertdate('%d.%m.%Y') }}
+  {% endcall %}
+
+applicants:
+  {% call(applicant) match('Applicants.item', mark) %}
+      - identifier: {{ applicant.PersonenAuswahlId }}
+        fullName:
+          - text: {{ applicant | get_name }}
+            languageCode: de
+        fullAddress:
+          - languageCode: de
+            text: {{ applicant | get_address }}
+        countryCode: {{ applicant.Land }}
+  {% endcall %}
+
+representatives:
+  {% call(rep) match('Representatives.item', mark) %}
+      - identifier: {{ rep.PersonenAuswahlId }}
+        fullName:
+          - text: {{ rep | get_name }}
+            languageCode: de
+        fullAddress:
+          - languageCode: de
+            text: {{ rep | get_address }}
+        countryCode: {{ rep.Land }}
+  {% endcall %}
+
+{% endif %}

gbdtransformation/brands/autm/__init__.py

@@ -0,0 +1,2 @@
+render = 'JSON'
+source = 'national'

gbdtransformation/brands/autm/filters.py

@@ -0,0 +1,222 @@
+from datetime import datetime, date
+from gbdtransformation.brands import kinds as std_kinds
+from gbdtransformation.brands import status as std_status
+from gbdtransformation.brands import features as std_features
+
+ignore_namespace = [
+   'http://www.ipaustralia.gov.au/trademarks/schema/tm-extract/2005/2',
+   'http://www.ipaustralia.gov.au/trademarks/schema/tm-extract/2012/1'
+]
+
+def translate_feature(feature, words=None):
+    # needed information from office
+    if not feature or not isinstance(feature, str): return 'Undefined'
+
+    # out-of-the-box match
+    if feature.capitalize() in std_features:
+        return feature.capitalize()
+
+    lst = feature.split(', ')
+
+    has_words  = words or _lst_has(lst, 'Word')
+    has_figure = _lst_has(lst, 'Shape', 'Device', 'Figurative')
+
+    if has_words and has_figure: return 'Combined'
+    if _lst_has(lst, 'Word'): return 'Word'
+    if _lst_has(lst, 'Movement'): return 'Motion'
+    if _lst_has(lst, 'Shape'): return 'Three dimensional'
+    if _lst_has(lst, 'Figurative'): return 'Figurative'
+    if _lst_has(lst, 'Fancy'): return 'Stylized characters'
+    if _lst_has(lst, 'Colour'): return 'Colour'
+    if _lst_has(lst, 'Scent'): return 'Olfactory'
+    if _lst_has(lst, 'Feel'): return 'Touch'
+    if _lst_has(lst, 'Other'): return 'Other'
+
+    return 'Other'
+    #raise Exception('Feature "%s" unmapped' % feature)
+
+def translate_status(status):
+    if not status: return 'Unknown'
+
+    # out-of-the-box match
+    if status.capitalize() in std_status:
+        return status.capitalize()
+
+    status_translated = _status_map.get(status.lower(), None)
+
+    if not status_translated:
+        return 'Unknown'
+        #raise Exception('Status "%s" unmapped' % status)
+
+    return status_translated
+
+
+def translate_kind(kind):
+    # out-of-the-box match
+    if kind.capitalize() in std_kinds:
+        return [kind.capitalize()]
+
+    if kind == 'Trade': return ['Individual']
+    if kind == 'Certification': return ['Certificate']
+
+    if not kind: return ['Individual']
+
+    return ['Other']
+    #raise Exception('kind "%s" is not mapped.' % kind)
+
+
+# -------------------------
+# handling dates exceptions
+# -------------------------
+def get_application_date(tm):
+    sdate = tm.BASGR.BASAPPD
+    # application date not set
+    if not sdate:
+        rdate = tm.BASGR.BASREGD
+        if rdate:
+            return rdate
+        try:
+            irdate = tm.INTREGG.NTFDATE
+            if irdate:
+                return irdate
+        except: pass
+
+    return sdate
+
+def get_registration_date(tm):
+    rdate = tm.BASGR.BASREGD
+    if rdate:
+        return rdate
+
+    # try to look in registration publication
+    try:
+        return tm.PUBREG.PUBREGD
+    except: pass
+
+
+def get_expiry_date(tm):
+    edate = tm.BASGR.BASREND
+    # expiry date not set
+    if not edate:
+        status = tm.BASGR.BASSTA
+        if status.endswith('Renewal fee not paid') or status.startswith('Registered'):
+            sdate = tm.BASGR.BASREGD
+            # add 10 years to registration date
+            if sdate:
+                sdate = datetime.strptime(sdate, '%Y%m%d')
+                try:
+                    edate = sdate.replace(year = sdate.year + 10)
+                except ValueError:
+                    edate = sdate + (date(sdate.year + 10, 3, 1) - date(sdate.year, 3, 1))
+
+                edate = edate.strftime('%Y%m%d')
+
+    return edate
+
+# -----------------------------------------------------
+# helpers for applicants/representatives/correspondence
+# -----------------------------------------------------
+def unique_persons(persons):
+    if not persons:
+        return []
+
+    if not isinstance(persons, list):
+        persons = [persons]
+
+    # records are sometines duplicated with same NAML8
+    # ADDRL8 666666:XX - "Refer to WIPO correspondence" (International Application)
+    unique_by_identifier = list({p.get('NAML8', None): p
+        for p in persons
+        if not p.ADDRL8 == '666666:XX' }.values())
+
+    return unique_by_identifier
+
+def get_person_name(person):
+    if not person:
+        return None
+
+    name_lst = [person.NAML4, person.NAML5, person.NAML3, person.NAML6]
+    name_lst = list(filter(None, name_lst))
+    return ' '.join(name_lst)
+
+# ------------
+# helpers
+# ------------
+# get the injected tag: WIPO_IMGNB
+def get_nb_images(tm):
+    try:
+        if tm.MARKDET.DEVDESC is not None: return 1
+    except: pass
+    return 0
+             # NOT INJECTION ANYMORE int(tm[list(tm.keys()).pop()])
+
+# split on ',' if series
+def get_word_series(text, is_series):
+    if not text:
+        return []
+
+    return text.split(',') if is_series else [text]
+
+def _lst_has(lst, *values):
+    for value in values:
+        value = value.lower()
+        for item in lst:
+            if item.lower().startswith(value):
+                return True
+    return False
+
+_status_map = {
+    'published: awaiting examination': 'Pending',
+    'accepted: awaiting advertisement': 'Pending',
+    'accepted: opposed': 'Pending',
+    'accepted: in opposition period': 'Pending',
+    'accepted: opposition period expired': 'Pending',
+    'accepted: under examination': 'Pending',
+    'published: awaiting indexing': 'Pending',
+    'published: awaiting examination': 'Pending',
+    'published: under examination': 'Pending',
+    'published: under examination - hearing requested': 'Pending',
+    'published: under examination - deferred': 'Pending',
+    'published: under examination - court action': 'Pending',
+    'published: deferred awaiting certification rules assessment': 'Pending',
+    'published: cancelled at the request of ib': 'Ended',
+
+    'accepted: awaiting publication': 'Registered',
+
+    'registered: registered/protected': 'Registered',
+    'protected: registered/protected': 'Registered',
+    'registered: renewal due': 'Registered',
+    'protected: renewal due': 'Registered',
+
+    'linked: linked/merged before registration': 'Ended',
+    'linked: linked/merged after registration': 'Ended',
+    'merged: linked/merged before registration': 'Ended',
+    'merged: linked/merged after registration': 'Ended',
+
+    'lapsed: notice of intention to defend not filed': 'Ended',
+    'lapsed: registration fee not paid on time': 'Ended',
+    'lapsed: not accepted': 'Ended',
+    'lapsed: in opposition period': 'Ended',
+    'lapsed: under examination': 'Ended',
+    'removed: non-use': 'Ended',
+    'removed: registrar cessation': 'Ended',
+    'rejected: examination requirements not met': 'Ended',
+    'withdrawn: cancelled before protection': 'Ended',
+    'cancelled: owner request': 'Ended',
+    'cancelled: cancelled by a court': 'Ended',
+    'cancelled: cancelled at the request of ib': 'Ended',
+    'cancelled: cancelled for unknown reason': 'Ended',
+    'refused: opposition successful': 'Ended',
+    'refused: irda notice of intention to defend not filed': 'Ended',
+    'refused: pre 1995 refused': 'Ended',
+    'withdrawn: applicant request': 'Ended',
+    'ceased: non-use': 'Ended',
+    'ceased: registrar cessation': 'Ended',
+    'not protected: not accepted': 'Ended',
+    'not protected: registration fee not paid on time': 'Ended',
+    'not protected: notice of intention to defend not filed': 'Ended',
+    'registered: expired renewal possible': 'Expired',
+    'protected: expired renewal possible': 'Expired',
+    'removed - not renewed: renewal fee not paid': 'Expired',
+    'ceased - not renewed: renewal fee not paid': 'Expired'
+}

gbdtransformation/brands/autm/schema

@@ -0,0 +1,91 @@
+/TMEXTRACT
+__/APCTADD
+____/ADDRL6
+____/ADDRL8
+____/COUNTRY
+____/NAML1
+____/NAML3
+____/NAML4
+____/NAML6
+____/NAML8
+____/POSTCDE
+__/BASGR
+____/BASAPPD
+____/BASAPPN
+____/BASCAND
+____/BASREGD
+____/BASREND
+____/BASSTA
+____/OOCC
+__/CIDET
+____/CITEXT
+____/CLMTADD
+______/ADDRL6
+______/ADDRL8
+______/COUNTRY
+______/NAML3
+______/NAML4
+______/NAML6
+______/NAML8
+______/POSTCDE
+____/CLSRVAD
+______/ADDRL6
+______/ADDRL8
+______/COUNTRY
+______/NAML1
+______/NAML3
+______/NAML4
+______/NAML6
+______/NAML8
+______/POSTCDE
+__/DIVCLM
+____/PARAPPD
+____/PARAPPN
+__/GSGR
+____/GSTERMO
+____/NICCLAI
+__/INTREGG
+____/CORADD
+______/ADDRL6
+______/ADDRL8
+______/COUNTRY
+______/NAML1
+______/NAML3
+______/NAML4
+______/NAML6
+______/NAML8
+______/POSTCDE
+____/INTREGN
+____/NTFDATE
+__/MARKDET
+____/DEVDESC
+____/DISCLAI
+____/MARDESC
+____/ORIGLAN
+____/TYPMARI
+____/TYPMARI[@nil=true]
+__/OTHTMDET
+____/TYPMARI
+__/PRIGR
+____/COUNTRY
+____/PRIAPPD
+____/PRIAPPN
+__/PUBAPP
+____/PUBAPPD
+____/PUBAPPIS
+____/PUBAPPYR
+__/PUBREG
+____/PUBREGD
+____/PUBREGIS
+____/PUBREGYR
+__/SRVCADD
+____/ADDRL6
+____/ADDRL8
+____/COUNTRY
+____/NAML1
+____/NAML3
+____/NAML4
+____/NAML6
+____/NAML8
+____/POSTCDE
+__/WIPO_IMGNB