wipo-gbd-transformation 1.1.75__py3-none-any.whl → 1.1.77__py3-none-any.whl

gbdtransformation/brands/brtm/filters.py

@@ -16,7 +16,9 @@ def translate_type(header):
 
     # extraction missing info.
     if not code:
-        raise Exception('Incomplete Document Info')
+        # defaulting rather than failing...
+        return 'TRADEMARK'
+        #raise Exception('Incomplete Document Info')
     if code == 'Marca': return 'TRADEMARK'
     if code == 'Marca Madri': return 'TRADEMARK'
     """
@@ -25,7 +27,8 @@ def translate_type(header):
     if code == 'Madrid': return 'TRADEMARK'
     if code == 'Banjul Protocol Marks': return 'TRADEMARK'
     """
-    raise Exception('Type "%s" is not mapped.' % code)
+    return 'TRADEMARK'
+    #raise Exception('Type "%s" is not mapped.' % code)
 
 def translate_kind(trademark, header):
     subcode = header.TransactionSubCode
@@ -49,7 +52,8 @@ def translate_kind(trademark, header):
     if subcode == 'Madrid Protocol': return ['Individual']
     if subcode == 'Banjul Protocol Marks': return ['Individual']
     """
-    raise Exception('Kind "%s" not mapped.' % subcode)
+    return ['Undefined']
+    #raise Exception('Kind "%s" not mapped.' % subcode)
 
 def translate_status(trademark):
     status = trademark.MarkCurrentStatusCode

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/notm/filters.py

@@ -1,12 +1,17 @@
 import re
 
 def translate_kind(kind):
-    if not kind: return ['Individual']
+    if not kind: return 'Individual'
 
-    if kind == 'Individual mark': return ['Individual']
-    if kind == 'Collective mark': return ['Collective']
+    if kind.lower() == 'individual mark': return 'Individual'
+    if kind.lower() == 'trademark': return 'Individual'
+    if kind.lower() == 'collective mark': return 'Collective'
+    if kind.lower() == 'guarantee' or kind.lower() =='guarantee mark': return 'Collective'
+    if kind.lower() == 'certificate' or kind.lower() =='certificate mark': return 'Certificate'
+    if kind.lower() == 'certification' or kind.lower() =='certification mark': return 'Certificate'
 
-    raise Exception('kind "%s" is not mapped.' % kind)
+    return 'Other'
+    #raise Exception('kind "%s" is not mapped.' % kind)
 
 def translate_status(status):
     if not status: return 'Ended'
@@ -74,6 +79,8 @@ def get_local_texts(nodes):
     return text
 
 def get_full_address(postalStructuredAddress):
+    if postalStructuredAddress is None:
+        return 
     result = ""
     if "addressLineText" in postalStructuredAddress:
         for addressLineText in postalStructuredAddress["addressLineText"]:
@@ -110,4 +117,38 @@ def local_guess_language(content):
             lang = "no"
         return lang
     else:
-        return "en"
+        return "en"
+
+def has_vienna_classes(markImage):
+    if not "markImageClassification" in markImage:
+        return False
+    if not "figurativeElementClassificationBag" in markImage["markImageClassification"]:
+        return False
+    if not "viennaClassificationBag" in markImage["markImageClassification"]["figurativeElementClassificationBag"]:
+        return False
+
+    for element in markImage["markImageClassification"]["figurativeElementClassificationBag"]["viennaClassificationBag"]:
+        if "viennaClassification" in element:
+            for viennaClassification in element["viennaClassification"]:
+                if "viennaCategory" in viennaClassification:
+                    return True
+    return False
+
+def translate_licence_category(kind):
+    if not kind: return 'Other'
+
+    if kind.lower() == 'exclusive': return 'Exclusive'
+    if kind.lower() == 'nonexclusive' or kind.lower() == 'non exclusive' or kind.lower() == 'non-exclusive': return 'NonExclusive'
+
+    return 'Other'
+    #raise Exception('licence category "%s" is not mapped.' % kind)
+
+def translate_licence_status(status):
+    if not status: return 'Other'
+    # Cancelled, Valid, Other
+
+    if status.lower() == 'cancelled': return 'Cancelled'
+    if status.lower() == 'valid': return 'Valid'
+
+    return 'Other'
+    #raise Exception('licence status "%s" is not mapped.' % status)

gbdtransformation/brands/notm/template.yml

@@ -14,6 +14,14 @@ registrationDate: {{ trademark.registrationDate }}
 
 expiryDate: {{ trademark.expiryDate }}
 
+# publication date appears as an event of category "markEventCategory": "Registration published"
+# with publication date given by markEventDate attribute
+{% call(event) match('markEvent', trademark.markEventBag) %}
+{% if event.markEventCategory == 'Registration published' %}  
+publicationDate: {{ event.markEventDate }}
+{% endif %}
+{% endcall %}
+
 {% set status = trademark.markCurrentStatusCode | translate_status %}
 gbdStatus: {{ status }}
 officeStatus: {{ trademark.markCurrentStatusCode }}
@@ -26,14 +34,23 @@ designatedCountries:
 type: TRADEMARK
 
 kind:
-  - Individual
+  {% call(markCategory) match('markCategory', trademark) %}
+  - {{ markCategory | translate_kind() }}
+  {% endcall %}
+  # (Individual|Collective|Certificate|Defensive|Other|Membership|Unknown)
 
 markFeature: {{ trademark.markFeatureDescription | translate_feature() }}
 # (Word|Stylized characters|Figurative|Combined|Three dimensional|Colour|Sound|Hologram|Olfactory|Motion|Municipal|Chimney|Other|Undefined)
 
-kind:
-  - Individual
-  # (Individual|Collective|Certificate|Defensive|Other|Membership)
+# in case it is relevant and available, we can store here the Madrid application from witch the national trademark originates
+{% set application_case = markApplicationCategory %}
+{% if application_case == 'International Mark' %}  
+reference:
+  registration:
+    - number: {{ trademark.trademarkTypeChoice1.registrationNumber }}
+      date: {{ trademark.registrationDate }}
+      office: "WO"
+{% endif %}
 
 markDisclaimerDetails:
   {% call(markDisclaimerText) match('markDisclaimerText', trademark.markDisclaimerBag) %}
@@ -69,6 +86,18 @@ markImageDetails:
       - languageCode:
         text: {{ markDescriptionText | get_local_text() }}
       {% endcall %}
+    {% set has_vienna_classes = markImage | has_vienna_classes() %}
+    {% if has_vienna_classes %}  
+    classification:
+      kind: Vienna
+      version: 
+      code:
+      {% call(viennaClass) match('viennaClassificationBag', markImage.markImageClassification.figurativeElementClassificationBag) %}
+      {% call(viennaValue) match('viennaClassification', viennaClass) %}
+        - {{ viennaValue.viennaCategory }}
+      {% endcall %}
+      {% endcall %}
+    {% endif %}
   {% endcall %}
 
 markSoundDetails:
@@ -119,7 +148,18 @@ representatives:
       - languageCode:
         text: {{ postalAddress.postalStructuredAddress | get_full_address() }}
       {% endcall %}
-    countryCode:
+    detailedAddress:
+      {% call(postalAddress) match('postalAddress', representative.contact.contactTypeChoiceSequence.postalAddressBag) %}
+      - languageCode:
+        text:
+        cityName: {{ postalAddress.postalStructuredAddress.cityName }}
+        geographicRegionName: 
+        postalCode: {{ postalAddress.postalStructuredAddress.postalCode }}
+        countryCode: {{ postalAddress.postalStructuredAddress.countryCode }}
+      {% endcall %}
+    {% call(postalAddress) match('postalAddress', representative.contact.contactTypeChoiceSequence.postalAddressBag) %}
+    countryCode: {{ postalAddress.postalStructuredAddress.countryCode }}
+    {% endcall %}  
   {% endcall %}
 
 correspondence:
@@ -143,7 +183,78 @@ applicants:
       - languageCode: 
         text: {{ postalAddress.postalStructuredAddress | get_full_address() }}
       {% endcall %}
-    countryCode: 
+    detailedAddress:
+      {% call(postalAddress) match('postalAddress', applicant.contact.contactTypeChoiceSequence.postalAddressBag) %}
+      - languageCode:
+        text:
+        cityName: {{ postalAddress.postalStructuredAddress.cityName }}
+        geographicRegionName: 
+        postalCode: {{ postalAddress.postalStructuredAddress.postalCode }}
+        countryCode: {{ postalAddress.postalStructuredAddress.countryCode }}
+      {% endcall %}
+    {% call(postalAddress) match('postalAddress', applicant.contact.contactTypeChoiceSequence.postalAddressBag) %}
+    countryCode: {{ postalAddress.postalStructuredAddress.countryCode }}
+    {% endcall %}  
+  {% endcall %}
+
+# licence information, not frequent, but provided by Singapore, Norway and UK as of 2025-04-23
+licences:
+  {% call(record) match('markRecord', trademark.markRecordBag) %}
+  {% if record.recordLicence.recordLicenceCategory == 'Licence' %}  
+  {% call(licence) match('licence', record.recordLicence.licenceBag) %}
+  - licenceCategory: {{ licence.licenceCategory | translate_licence_category() }}
+    # Exclusive, NonExclusive, Other
+    goodsServicesLimitation: 
+      {% call(goodsServices) match('commentText', licence.goodsServicesLimitation.commentTextBag) %}
+      - languageCode: 
+        text: {{ goodsServices.localizedTextType | get_local_text }}
+      {% endcall %}    
+    periodLimitationEndDate: {{ licence.periodLimitationEndDate }}
+    licenceDate: {{ licence.licenceDate }}
+    licenceStatus: {{ licence.licenceStatusCategory | translate_licence_status() }}
+    effectiveDate: {{ record.recordLicence.recordEffectiveDate }}
+    licensee:
+      {% call(licensee) match('licensee', licence.licenseeBag) %}
+      - identifier:
+        kind:
+        fullName:
+          - languageCode:
+            text: {{ licensee.contact.contactTypeChoiceSequence.name.entityName.phraseType | get_local_text }}
+        firstName:
+          - languageCode:
+            text:
+        lastName:
+          - languageCode:
+            text:
+        middleName:
+          - languageCode:
+            text:
+        organizationName:
+          - languageCode:
+            text: 
+        fullAddress:
+          {% call(postalAddress) match('postalAddress', licensee.contact.contactTypeChoiceSequence.postalAddressBag) %}
+          - languageCode:
+            text: {{ postalAddress.postalStructuredAddress | get_full_address() }}
+          {% endcall %}
+        detailedAddress:
+          {% call(postalAddress) match('postalAddress', licensee.contact.contactTypeChoiceSequence.postalAddressBag) %}
+          - languageCode:
+            text:
+            cityName: {{ postalAddress.postalStructuredAddress.cityName }}
+            geographicRegionName: 
+            postalCode: {{ postalAddress.postalStructuredAddress.postalCode }}
+            countryCode: {{ postalAddress.postalStructuredAddress.countryCode }}
+          {% endcall %}
+        contact:
+          phone: 
+          fax: 
+          email: 
+          url:
+        countryCode: # sometimes, country name is provided instead
+      {% endcall %}
+  {% endcall %}
+  {% endif %}
   {% endcall %}
 
 {% endcall %}

gbdtransformation/brands/xxxx/template.yml

@@ -23,7 +23,7 @@
 
 type: # (TRADEMARK|EMBLEM|AO|GI|INN)
 kind:
-  - str # (Individual|Collective|Certificate|Defensive|Other|Membership)
+  - 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)
 
 registrationOfficeCode:
@@ -187,6 +187,7 @@ applicants:
         cityName:
         geographicRegionName:
         postalCode:
+        countryCode:
     contact:
       phone: 
       fax: 
@@ -221,6 +222,7 @@ representatives:
         cityName:
         geographicRegionName:
         postalCode:
+        countryCode:
     contact:
       phone: 
       fax: 
@@ -253,6 +255,7 @@ correspondence:
       cityName:
       geographicRegionName:
       postalCode:
+      countryCode:
   contact:
     phone: 
     fax: 
@@ -272,5 +275,52 @@ appeals:
   - kind:
     date:
 
+# 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:
+
+

{wipo_gbd_transformation-1.1.75.dist-info → wipo_gbd_transformation-1.1.77.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wipo-gbd-transformation
-Version: 1.1.75
+Version: 1.1.77
 Summary: GBD XML ETL package
 Home-page: https://github.com/GBD-Wipo/xmlE
 Author: WIPO GDB team

{wipo_gbd_transformation-1.1.75.dist-info → wipo_gbd_transformation-1.1.77.dist-info}/RECORD

@@ -45,10 +45,11 @@ gbdtransformation/brands/bntm/schema,sha256=AP0MxQyD0hY4APRh8nxitlxMqJYJB4AaaTJ8
 gbdtransformation/brands/bntm/template.yml,sha256=PO7s1HDQM9ushIJuIX3z_dfWO-f62YDzBG_sYKDlnG8,34
 gbdtransformation/brands/bntm/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 gbdtransformation/brands/brtm/__init__.py,sha256=4i_g7tbu8MmPJccRZCkqJES_bzwGUY59SxTlZT_e3Xs,37
-gbdtransformation/brands/brtm/filters.py,sha256=_WbKSUYBmCghrP_Fkb4OjdczWkdRuxP2pHh3JCzeNEo,5890
+gbdtransformation/brands/brtm/filters.py,sha256=-T0JEm1VaWeveGjejdGuid8vHTcH3yKsayQWJDIP5Y0,6012
 gbdtransformation/brands/brtm/schema,sha256=TFrF4FR76cytcbtQkDWxtF74I0tCPRDIvWRFeqaJt6Q,3242
 gbdtransformation/brands/brtm/template.yml,sha256=U3dMrcxS-meJthPQow_R1MAVH1DYdJ4AyJSAR6s9LJQ,952
 gbdtransformation/brands/brtm/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gbdtransformation/brands/brtm/tests/test01.xml,sha256=PwEldq_lGbrysSYk43ebupzXP57T5_fhtpnQx_TqjB4,2231
 gbdtransformation/brands/bttm/__init__.py,sha256=cCkwMJ9sn4nPbrt8gZzcLovRJzV9uLi2L-6dU_KsIzg,229
 gbdtransformation/brands/bttm/filters.py,sha256=3OFCcjpjkIQ_GbYeGcwTpc-qWBZLUybaUzr4e4s-eEI,2326
 gbdtransformation/brands/bttm/schema,sha256=AP0MxQyD0hY4APRh8nxitlxMqJYJB4AaaTJ8y20-XBA,3283
@@ -296,8 +297,8 @@ gbdtransformation/brands/natm/schema,sha256=TFrF4FR76cytcbtQkDWxtF74I0tCPRDIvWRF
 gbdtransformation/brands/natm/template.yml,sha256=PO7s1HDQM9ushIJuIX3z_dfWO-f62YDzBG_sYKDlnG8,34
 gbdtransformation/brands/natm/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 gbdtransformation/brands/notm/__init__.py,sha256=YRZPymjJv7V5vqjphBN1UOHZ3RL1oeYYqaOI6AKInl0,88
-gbdtransformation/brands/notm/filters.py,sha256=1f1vF9kKTlMQ9K_Qh7Hk6OQ964WGWQ8BadNOu-61sIo,3738
-gbdtransformation/brands/notm/template.yml,sha256=UmJ35fKzAHQSYrECsJtXRXTE2egXM69oXcu0Ya5fqWA,5090
+gbdtransformation/brands/notm/filters.py,sha256=hFVIsTFyO41QGS98JqVlg0J16A0mg9Hw5rH48kW7pYc,5518
+gbdtransformation/brands/notm/template.yml,sha256=SE9mcE3VxgOErmJPssTXkLeKuDRrajVMYG_Zvdef9sM,10135
 gbdtransformation/brands/nztm/__init__.py,sha256=UHmbQDIPDdApISBKfO9tKOX6LgUQ_Ib-IVMR5kCVMTY,86
 gbdtransformation/brands/nztm/filters.py,sha256=dAjrg03Yq37H10oAM8rnAMNa71lZHuG1uMwHi25kIvA,4211
 gbdtransformation/brands/nztm/schema,sha256=tpcyNMtmiBQQ0FsxKKTASRSo4nbrw0j0_b1nhELyAzE,6355
@@ -456,7 +457,7 @@ gbdtransformation/brands/wstm/tests/test.xml.gz,sha256=UKm7LTvKaETUtHMKurFGqkqXO
 gbdtransformation/brands/xxxx/__init__.py,sha256=fricc3VHm4BwGRFKIIqB0t-NtP3tTVRrEYee_gWpiFo,172
 gbdtransformation/brands/xxxx/filters.py,sha256=YCaQ6yH2LINwCQvbPHDhnORQyWglbswLlSOY6ur3KXQ,1874
 gbdtransformation/brands/xxxx/schema,sha256=g_oWkd7k2e5fAQR1BdNkPSsIgP3dkTyc7esWo_UOHQA,163
-gbdtransformation/brands/xxxx/template.yml,sha256=OscSZDrec-rCfK0HVbOaIPmhkykZCWcxK54Zf7iZe6o,5872
+gbdtransformation/brands/xxxx/template.yml,sha256=EM5IES2irQvlNvylR_JRmIAtrUna0QzJKK5Jr_RqdzY,7104
 gbdtransformation/brands/zmtm/__init__.py,sha256=Mtsi_-CaLQirHkhnletNhJ4li-pZlzEZMcKjv6mEk50,256
 gbdtransformation/brands/zmtm/filters.py,sha256=FkGfv3nPiYDUy97O7bDzPp824qoDsqX-oh2Ox01NTpA,2344
 gbdtransformation/brands/zmtm/schema,sha256=TFrF4FR76cytcbtQkDWxtF74I0tCPRDIvWRFeqaJt6Q,3242
@@ -584,9 +585,9 @@ gbdtransformation/utilities/st66.xsd,sha256=co8aFN3a5TpudllRttWmfLeiZu8ulNipfeXm
 schemas/ShazamConfig.py,sha256=D67os5B11C41h_WZ7kk54Ss0Kk7tHh8W0d_1c_aX-lY,1191
 schemas/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 schemas/schema_extractor.py,sha256=3-ImtnI777f6b3VA0A_w-NoXdlGz5VZMzK6MnPdQQAY,10294
-wipo_gbd_transformation-1.1.75.dist-info/LICENSE.md,sha256=6r2dL13EwZqSt2ellLbJRFTA-6ECIDOer4YthCfkac0,35654
-wipo_gbd_transformation-1.1.75.dist-info/METADATA,sha256=VeeKM8Bu-kxQaq8SzYx_CJXGheafEd0rWGqllC_5-3I,577
-wipo_gbd_transformation-1.1.75.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-wipo_gbd_transformation-1.1.75.dist-info/entry_points.txt,sha256=NFLtlP3mPHUi-hEoUcz4CXa7vcpP8bbwd18HS4arbEk,223
-wipo_gbd_transformation-1.1.75.dist-info/top_level.txt,sha256=oU1j-JNLga18Fd-EV6Xl9wM8zxYoNVEzb7P8MDhTPJg,26
-wipo_gbd_transformation-1.1.75.dist-info/RECORD,,
+wipo_gbd_transformation-1.1.77.dist-info/LICENSE.md,sha256=6r2dL13EwZqSt2ellLbJRFTA-6ECIDOer4YthCfkac0,35654
+wipo_gbd_transformation-1.1.77.dist-info/METADATA,sha256=UcDXShGJZ47hV1I4RKR52q6FvHP1wE2wc-tdS8diHNI,577
+wipo_gbd_transformation-1.1.77.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+wipo_gbd_transformation-1.1.77.dist-info/entry_points.txt,sha256=NFLtlP3mPHUi-hEoUcz4CXa7vcpP8bbwd18HS4arbEk,223
+wipo_gbd_transformation-1.1.77.dist-info/top_level.txt,sha256=oU1j-JNLga18Fd-EV6Xl9wM8zxYoNVEzb7P8MDhTPJg,26
+wipo_gbd_transformation-1.1.77.dist-info/RECORD,,