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

gbdtransformation/brands/wstm/tests/test.xml

@@ -0,0 +1,132 @@
+<?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>Trademark</TransactionCode>
+      <TransactionSubCode>Mark-Overseas</TransactionSubCode>
+      <TransactionData>
+        <TradeMarkApplication>
+          <TradeMarkDetails>
+            <TradeMark>
+              <RegistrationOfficeCode>WS</RegistrationOfficeCode>
+              <ApplicationNumber>WS/T/620</ApplicationNumber>
+              <ApplicationDate>1973-12-11</ApplicationDate>
+              <RegistrationNumber>620</RegistrationNumber>
+              <RegistrationDate>1976-04-05</RegistrationDate>
+              <ApplicationLanguageCode>en</ApplicationLanguageCode>
+              <ExpiryDate>2016-05-08</ExpiryDate>
+              <MarkCurrentStatusDate>2020-06-11</MarkCurrentStatusDate>
+              <KindMark>Individual</KindMark>
+              <MarkImageDetails>
+                <MarkImage>
+                  <MarkImageFilename>ATTACHMENT/logo</MarkImageFilename>
+                  <MarkImageFileFormat>JPEG</MarkImageFileFormat>
+                </MarkImage>
+              </MarkImageDetails>
+              <GoodsServicesDetails>
+                <GoodsServices>
+                  <ClassDescriptionDetails>
+                    <ClassDescription>
+                      <ClassNumber>11</ClassNumber>
+                      <GoodsServicesDescription languageCode="en">Plumbing fixtures including lavatories, water closets, urinals, bidets, and brass and chromium plated ware used therewith in this class; air conditioning apparatus, refrigerating apparatus</GoodsServicesDescription>
+                    </ClassDescription>
+                  </ClassDescriptionDetails>
+                </GoodsServices>
+              </GoodsServicesDetails>
+              <PriorityDetails>
+                <Priority>
+                  <PriorityCountryCode>NZ</PriorityCountryCode>
+                  <PriorityNumber>84035</PriorityNumber>
+                  <PriorityDate>1967-05-08</PriorityDate>
+                </Priority>
+              </PriorityDetails>
+              <ApplicantDetails>
+                <Applicant>
+                  <ApplicantAddressBook>
+                    <FormattedNameAddress>
+                      <Name>
+                        <FreeFormatName>
+                          <FreeFormatNameDetails>
+                            <FreeFormatNameLine languageCode="en">IDEAL STANDARD INTERNATIONAL BVBA</FreeFormatNameLine>
+                          </FreeFormatNameDetails>
+                        </FreeFormatName>
+                      </Name>
+                      <Address>
+                        <AddressCountryCode>-</AddressCountryCode>
+                        <FreeFormatAddress>
+                          <FreeFormatAddressLine>1160 Chaussee de Wavre, 1789, Box 15 Brussels</FreeFormatAddressLine>
+                        </FreeFormatAddress>
+                      </Address>
+                    </FormattedNameAddress>
+                  </ApplicantAddressBook>
+                </Applicant>
+              </ApplicantDetails>
+              <RepresentativeDetails>
+                <Representative>
+                  <RepresentativeAddressBook>
+                    <FormattedNameAddress>
+                      <Name>
+                        <FreeFormatName>
+                          <FreeFormatNameDetails>
+                            <FreeFormatNameLine languageCode="en">A J PARK</FreeFormatNameLine>
+                          </FreeFormatNameDetails>
+                        </FreeFormatName>
+                      </Name>
+                      <Address>
+                        <AddressCountryCode>NZ</AddressCountryCode>
+                        <FreeFormatAddress>
+                          <FreeFormatAddressLine>LEVEL 22, STATE INSURANCE TOWER, 1 WILLIS STREET, WELLINGTON 6011, NEW ZEALAND</FreeFormatAddressLine>
+                        </FreeFormatAddress>
+                      </Address>
+                    </FormattedNameAddress>
+                  </RepresentativeAddressBook>
+                </Representative>
+                <Representative>
+                  <RepresentativeAddressBook>
+                    <FormattedNameAddress>
+                      <Name>
+                        <FreeFormatName>
+                          <FreeFormatNameDetails>
+                            <FreeFormatNameLine languageCode="en">STEVENSONS LAWYERS</FreeFormatNameLine>
+                          </FreeFormatNameDetails>
+                        </FreeFormatName>
+                      </Name>
+                      <Address>
+                        <AddressCountryCode>WS</AddressCountryCode>
+                        <FreeFormatAddress>
+                          <FreeFormatAddressLine>PO BOX 210, APIA, SAMOA</FreeFormatAddressLine>
+                        </FreeFormatAddress>
+                      </Address>
+                    </FormattedNameAddress>
+                  </RepresentativeAddressBook>
+                </Representative>
+              </RepresentativeDetails>
+              <wo:WordMarkSpecification>
+                <wo:MarkVerbalElementText languageCode="en">AMERICAN STANDARD (label)</wo:MarkVerbalElementText>
+              </wo:WordMarkSpecification>
+              <wo:MarkEventDetails>
+                <wo:MarkEvent>
+                  <wo:MarkEventDate>1973-12-11</wo:MarkEventDate>
+                  <wo:MarkEventCode>Filed</wo:MarkEventCode>
+                </wo:MarkEvent>
+                <wo:MarkEvent>
+                  <wo:MarkEventDate>1976-04-05</wo:MarkEventDate>
+                  <wo:MarkEventCode>Registered</wo:MarkEventCode>
+                </wo:MarkEvent>
+                <wo:MarkEvent>
+                  <wo:MarkEventDate>2020-06-11</wo:MarkEventDate>
+                  <wo:MarkEventCode>Expired</wo:MarkEventCode>
+                  <wo:OfficeSpecificMarkEventCode>1018</wo:OfficeSpecificMarkEventCode>
+                  <wo:OfficeSpecificMarkEventDescription languageCode="en">Expired/Removed</wo:OfficeSpecificMarkEventDescription>
+                </wo:MarkEvent>
+              </wo:MarkEventDetails>
+              <wo:MarkCurrentStatusCode>Expired</wo:MarkCurrentStatusCode>
+            </TradeMark>
+          </TradeMarkDetails>
+        </TradeMarkApplication>
+      </TransactionData>
+    </TransactionContentDetails>
+  </TradeMarkTransactionBody>
+</Transaction>

gbdtransformation/brands/xxxx/__init__.py

@@ -0,0 +1,6 @@
+# instruction to render the output to JSON format
+render = 'JSON'
+source = 'national' # national | multinational | international
+
+appnum_mask = '(.*)'
+regnum_mask = '(.*)'

gbdtransformation/brands/xxxx/filters.py

@@ -0,0 +1,60 @@
+# 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
+
+# namespaces defined in XML and to be ignored in procecssing
+ignore_namespace = []
+
+
+# -------------------------------------------------------------
+# data translation helpers:
+# translate values from office interpretation to gbd equivalent
+# -------------------------------------------------------------
+
+def translate_kind(kind):
+    """translation of the kind of trademark to a
+        multivalue gbd interpretation"""
+
+    # out-of-the-box match
+    if kind.capitalize() in std_kinds:
+        return [kind.capitalize()]
+
+    # __insert here__ : translation logic
+
+    # raise Exception to recognize unmapped values
+    raise Exception('kind "%s" is not mapped.' % kind)
+
+def translate_status(status):
+    """translation of mark status"""
+    # a required data from office. if not present and no way to guess,
+    # return Unknown
+    if not status: return 'Unknown'
+
+    # out-of-the-box match
+    if status.capitalize() in std_status:
+        return status.capitalize()
+
+    # __insert here__ : translation logic
+
+    # raise Exception to recognize unmapped values
+    raise Exception('Status "%s" unmapped' % status)
+
+
+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'
+
+    # out-of-the-box match
+    if feature.capitalize() in std_features:
+        return feature.capitalize()
+
+    # __insert here__ : translation logic
+
+    # raise Exception to recognize unmapped values
+    raise Exception('Feature "%s" unmapped' % feature)
+

gbdtransformation/brands/xxxx/schema

@@ -0,0 +1,4 @@
+# generate this file using
+$ gbd-transform-xpath /data/brands/collections/totm -o gbdtransformation/brands/totm/schema
+
+This process runs with a speed of 1000/sec

gbdtransformation/brands/xxxx/template.yml

@@ -0,0 +1,363 @@
+{% from 'navigation.tmpl' import match %}
+
+# common filter methods accessible in this template
+# gbdtransformation.common.filters
+#   .convertdate
+#   .contains
+#   .append
+#   .guess_language
+#   . ...
+# gbdtransformation.brands.filters
+#   .st13
+#   .pad_vienna
+#   .split_terms (for goods and services)
+#
+# TESTING:
+# developing the template:
+#   see the transformation output:
+#       gbd-transform /data/brands/collections/xxtm/ xxtm -t1
+#   test for transformation errors:
+#       gbd-transform /data/brands/collections/xxtm/ xxtm -r200 -w4 -q
+# validating the template:
+#   gbd-transform /data/brands/collections/xxtm/ xxtm -r2000 -w40 -q --qc
+
+type: # (TRADEMARK|EMBLEM|AO|GI|INN)
+kind:
+  - str # (Individual|Collective|Certificate|Defensive|Other|Membership|Undefined)
+markFeature: # (Word|Stylized characters|Figurative|Combined|Three dimensional|Colour|Sound|Hologram|Olfactory|Motion|Municipal|Chimney|Other|Undefined|Unknown)
+
+registrationOfficeCode:
+designatedCountries:
+  - str (CountryCode)
+
+# rarely passed
+filingPlace:
+
+# some collections indicate that the application
+# originates from international filing and provide IR number
+# (question to ask in GBD participation questionnaire)
+reference:
+  application:
+    - number:
+      date:
+      office:
+  registration:
+    - number:
+      date:
+      office:
+
+# can be deduced from appnum given office cc and (optional) appdate
+st13: # {{ Trademark.ApplicationNumber | st13('XX', appdate=... }}
+
+applicationNumber:
+# dates can be converted if not matching expected format
+applicationDate: # ex: {{ Trademark.ApplicationDate | convertdate('%Y%m%d') }}
+
+publicationDate: #
+
+# some collections have registration number
+# equals application number when registered
+registrationNumber:
+# some collections we can guess registration date
+# from event list
+registrationDate:
+
+applicationLanguageCode:
+# rarely passed
+secondLanguageCode:
+
+expiryDate:
+# rarely passed
+terminationDate:
+
+# status as is in the document
+officeStatus:
+# status as translated to gbdFormat
+gbdStatus:  # (Ended|Expired|Pending|Registered|Unknown|Delete)
+# can also be the date of the last event in markevents if given
+statusDate:
+
+markDisclaimerDetails:
+  - languageCode: # use guess_language to set it if not passed
+                  # ex {{ Trademark.MarkDisclaimerDetails | guess_language(lang='..', default='..') }}
+                  #   lang: the language if provided in doc
+                  #   default: default language if lang not provided.
+                  #   if no lang no default => use langdetect library
+    text:
+
+markDescriptionDetails:
+  - languageCode:
+    text:
+
+wordMarkSpecification:
+  markVerbalElement:
+    - languageCode:
+      text:
+  markSignificantVerbalElement:
+    - languageCode:
+      text:
+  markTranslation:
+    - languageCode:
+      text:
+  markTransliteration:
+
+markImageDetails:
+  - name:
+    colourIndicator:
+    colourClaimed:
+      - languageCode:
+        text:
+    description:
+      - languageCode:
+        text:
+    classification:
+      kind: Vienna #mostly
+      version: 7 #mostly
+      code:
+        - string
+
+markSoundDetails:
+  - filename:
+    fileformat:
+
+markVideoDetails:
+  - filename:
+    fileformat:
+
+goodsServicesClassification:
+  kind: Nice #inid (511)
+  version:
+  class:
+    - code:
+      terms:
+        - {{ languageCode }}:
+          - str
+
+nationalGoodsServicesClassification:
+  kind: KIPO # for eg
+  version:
+  class:
+    - code:
+      terms:
+        - {{ languageCode }}:
+          - str
+
+# some datasets have goods and services
+# terms that are not classified under a
+# nice class
+goodsServicesUnclassified:
+  {{ languageCode }}:
+    - str
+
+priorities:
+  - countryCode:
+    number:
+    date:
+    comment:
+
+publications:
+  - identifier:
+    date:
+    section:
+
+applicants:
+  - identifier:
+    kind:
+    fullName:
+      - languageCode:
+        text:
+    firstName:
+      - languageCode:
+        text:
+    lastName:
+      - languageCode:
+        text:
+    middleName:
+      - languageCode:
+        text:
+    organizationName:
+      - languageCode:
+        text:
+    fullAddress:
+      - languageCode:
+        text:
+    detailedAddress:
+      - languageCode:
+        text:
+        cityName:
+        geographicRegionName:
+        postalCode:
+        countryCode:
+    contact:
+      phone: 
+      fax: 
+      email: 
+      url:
+    countryCode: # sometimes, country name is provided instead
+
+# if different from applicants, and explicitely distinguished from them
+holders:
+  - identifier:
+    kind:
+    fullName:
+      - languageCode:
+        text:
+    firstName:
+      - languageCode:
+        text:
+    lastName:
+      - languageCode:
+        text:
+    middleName:
+      - languageCode:
+        text:
+    organizationName:
+      - languageCode:
+        text:
+    fullAddress:
+      - languageCode:
+        text:
+    detailedAddress:
+      - languageCode:
+        text:
+        cityName:
+        geographicRegionName:
+        postalCode:
+        countryCode:
+    contact:
+      phone: 
+      fax: 
+      email: 
+      url:
+    countryCode: # sometimes, country name is provided instead
+
+representatives:
+  - identifier:
+    kind:
+    fullName:
+      - languageCode:
+        text:
+    firstName:
+      - languageCode:
+        text:
+    lastName:
+      - languageCode:
+        text:
+    middleName:
+      - languageCode:
+        text:
+    organizationName:
+      - languageCode:
+        text:
+    fullAddress:
+      - languageCode:
+        text:
+    detailedAddress:
+      - languageCode:
+        text:
+        cityName:
+        geographicRegionName:
+        postalCode:
+        countryCode:
+    contact:
+      phone: 
+      fax: 
+      email: 
+      url:
+    countryCode: # sometimes, country name is provided instead
+
+correspondence:
+  fullName:
+    - languageCode:
+      text:
+  firstName:
+    - languageCode:
+      text:
+  lastName:
+    - languageCode:
+      text:
+  middleName:
+    - languageCode:
+      text:
+  organizationName:
+    - languageCode:
+      text:
+  fullAddress:
+    - languageCode:
+      text:
+  detailedAddress:
+    - languageCode:
+      text:
+      cityName:
+      geographicRegionName:
+      postalCode:
+      countryCode:
+  contact:
+    phone: 
+    fax: 
+    email: 
+    url:
+  countryCode:
+
+events:
+  - officeKind:
+    gbdKind: # Filed, Registered, Published, Pending, Inactive,
+              # Opposed, Withdrawn, Expired, Examined, Invalidated,
+              # Rejected, Abandoned, Suspended, Surrendered, Appealed,
+              # Awaiting court action, Converted, Notification, Unknown
+    date:
+
+appeals:
+  - kind:
+    date:
+    decisionDate: 
+
+# licence information, not frequent, but provided by Singapore, Norway and UK as of 2025-04-23
+licences:
+  - licenceCategory: # Exclusive, NonExclusive, Other
+    goodsServicesLimitation: 
+      - languageCode:
+        text:
+    periodLimitationEndDate:
+    licenceDate: # date Agreement signed
+    licenceStatus: # Cancelled, Valid, Other
+    effectiveDate: # date notice received at the IP office
+    licensee:
+      - identifier:
+        kind:
+        fullName:
+          - languageCode:
+            text:
+        firstName:
+          - languageCode:
+            text:
+        lastName:
+          - languageCode:
+            text:
+        middleName:
+          - languageCode:
+            text:
+        organizationName:
+          - languageCode:
+            text:
+        fullAddress:
+          - languageCode:
+            text:
+        detailedAddress:
+          - languageCode:
+            text:
+            cityName:
+            geographicRegionName:
+            postalCode:
+            countryCode:
+        contact:
+          phone: 
+          fax: 
+          email: 
+          url:
+        countryCode: # sometimes, country name is provided instead
+
+# here goes extra information that is office specific and that is pertinent for us to retain.
+extra:
+
+

gbdtransformation/brands/zmtm/__init__.py

@@ -0,0 +1,12 @@
+render = 'JSON'
+source = 'national'
+
+# ZM/T/2019/001818
+# ZM/M/2019/001818
+# MT/T/2016/000740
+appnum_mask = [ 'ZM/(M|T)/\\d{4}/(\\d*)',
+                '(M)T/(M|T)/\\d{4}/(\\d*)' ]
+
+# 2020/001154
+regnum_mask = [ '\\d{4}/(\\d*)',
+                '(\\d*)' ]

gbdtransformation/brands/zmtm/filters.py

@@ -0,0 +1,79 @@
+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 appnum.split('/')[-2].zfill(4)
+
+def translate_type(header):
+    code = header.TransactionCode
+
+    if code == 'National Mark': 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 == 'Servicemark': return ['Individual']
+    if subcode == 'Defensive Mark': return ['Defensive']
+    if subcode == 'Certification Mark': return ['Certificate']
+
+    raise Exception('Kind "%s" not mapped.' % subcode)
+
+def translate_status(trademark):
+    status = trademark.MarkCurrentStatusCode
+    if status in ['457', '1760', '259', '110']: return 'Unknown'
+    if status == 'Inactive':
+        if trademark.ExpiryDate: return 'Expired'
+        else: return 'Ended'
+
+    return ipas.translate_status(status)
+
+def translate_feature(trademark):
+    feature = trademark.MarkFeature
+
+    return ipas.translate_feature(feature)
+
+def translate_event(event):
+    return ipas.translate_event(event)
+
+# ---------------------------------------
+
+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):
+    regnum = trademark.RegistrationNumber
+    if regnum:
+        if regnum.endswith('/'):
+            regnum = regnum[:-1]
+        return regnum
+
+    if not tmstatus in ['Expired', 'Registered']:
+        return None
+
+    # ZM/T/2014/000113 => 2014/000113
+    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):
+    return False
+
+def get_ir_refnum(appnum):
+    return
+
+def get_goods_services(goods_services):
+    return ipas.get_goods_services(goods_services)