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

gbdtransformation/common/jprp/filters.py

@@ -0,0 +1,86 @@
+import math
+from pandas import Series
+
+def first(series):
+    if isinstance(series, str) or isinstance(series, int) or isinstance(series, float):
+        return series
+    if series.empty:
+        return None
+    if len(series.to_list()) > 0:
+        return series.to_list()[0]
+    return None
+
+def translate_kind(kind):
+    if kind == '1': return 'Collective'
+    return 'Individual'
+
+jptm_rep_types = {
+    "0": "No Representative",
+    "1": "Representative",
+    "2": "Acting representative",
+    "3": "Designated representative",
+    "4": "Legal representative",
+}
+
+jptm_status_country = {
+    "1": "Domestic registration",  # LIVE registered?
+    "2": "Domestic application",  # LIVE Pending ?
+    "3": "International registration",  # LIVE Registered ?
+    "A": "Domestic registration",  # DEAD Ended
+    "B": "Domestic registration",  # DEAD Ended
+    "C": "International registration",  # DEAD Ended
+    "None": "Unknown"}
+
+
+def representative_type(rep_typ_code):
+    if isinstance(rep_typ_code, float) and math.isnan(rep_typ_code):
+        return
+    return jptm_rep_types[str(int(rep_typ_code))]
+
+
+jptm_status_gbd = {
+    "1": "Registered",
+    "2": "Pending",  # ??
+    "3": "Registered",
+    "A": "Ended",  # ??
+    "B": "Ended",  # ??
+    "C": "Ended",  # ??
+    "None": "Unknown"
+}
+
+
+def status_office(status):
+    code = first(status)
+    return jptm_status_country[str(code)]
+
+
+def status_gbd(status):
+    code = first(status)
+    return jptm_status_gbd[str(code)]
+
+
+features = {
+    "0": "Not a special trademark",
+    "1": "Three dimensional",
+    "2": "Sound",
+    "3": "Motion",
+    "4": "Hologram",
+    "5": "Colour",
+    "6": "Position",
+    "9": "Other",
+    '': "Undefined" }
+
+def make_feature(feature_code):
+    # print("Make Feature [", feature_code, "]", type(feature_code))
+    if feature_code is None:
+        return 'Undefined'
+    if isinstance(feature_code, bool):
+        return 'Undefined'
+    if isinstance(feature_code, Series) and feature_code.empty():
+        return 'Undefined'
+    if isinstance(feature_code, float) and math.isnan(feature_code):
+        return 'Undefined'
+    if isinstance(feature_code, float):
+        feature_code = int(feature_code)
+
+    return features[str(feature_code)]

gbdtransformation/common/jprp/template.yml

@@ -0,0 +1,51 @@
+kind: {{tm.master.group_t_flg |first|to_str|translate_kind}}
+
+applicationNumber: {{tm.master.app_num|first}}
+applicationDate: {{tm.master.app_dt|first|to_str|convertdate('%Y%m%d') }}
+
+registrationNumber: {{tm.master.reg_num|first}}
+registrationDate: {{tm.master.set_reg_dt|first|to_str|convertdate('%Y%m%d')}}
+
+markFeature: {{ tm.master.special_t_id | first| make_feature }}
+
+reference:
+{% if tm.refs.intl_reg_num %}
+  office: WO
+  registration:
+    - number: {{ tm.refs.intl_reg_num }}
+      date: {{ tm.refs.intl_reg_dt|convertdate('%Y%m%d') }}
+{% endif %}
+
+
+{% if tm.goods.size > 0 %}
+goodsServicesClassification:
+  class:
+  {% for g in tm.goods.itertuples() %}
+    - code: {{ g.desig_goods_or_desig_wrk_class | int }}
+      term:
+      {% for term in g.desg_gds_name_desg_wrk_name|to_str|split_terms('，') %}
+        - {{ term }}
+      {% endfor %}
+  {% endfor %}
+{% endif %}
+
+{% if tm.holders.size > 0 %}
+applicants:
+{% for hol in tm.holders.itertuples() %}
+  - identifier: {{ hol.right_person_appl_id| int }}
+    fullName: {{hol.right_person_name | try_to_8bit }}
+    fullAddress: {{hol.right_person_addr | try_to_8bit }}
+{% endfor %}
+{% endif %}
+
+{% if tm.reps.size > 0 %}
+representatives:
+{% for rep in tm.reps.itertuples() %}
+  - identifier: {{rep.atty_appl_id | int }}
+    kind: {{ rep.atty_typ| representative_type }}
+    fullName: {{ rep.atty_name | try_to_8bit }}
+{% endfor %}
+{% endif %}
+
+extra:
+  divisionNumber: {{tm.master.split_num|first}}

gbdtransformation/common/navigation.tmpl

@@ -0,0 +1,12 @@
+{% macro match(path, scope) -%}
+    {% for elem in scope | matchpath(path) %}
+        {% if elem %} {{ caller(elem) }} {% endif %}
+    {% endfor %}
+{%- endmacro %}
+
+{% macro enumerate(path, scope) -%}
+    {% for elem in scope | matchpath(path) %}
+        {% if elem %} {{ caller(elem, loop.index) }} {% endif %}
+    {% endfor %}
+{%- endmacro %}
+

gbdtransformation/commons/emap/__init__.py

@@ -0,0 +1 @@
+render = 'JSON'

gbdtransformation/commons/emap/filters.py

@@ -0,0 +1,16 @@
+ignore_namespace = ['http://www.euipo.europa.eu/EUTM/EUTM_Download']
+
+def create_full_name(name): 
+	result = ""
+	
+	if name.FirstName: 
+		result += name.FirstName + " "
+	if name.LastName:
+		result += name.LastName
+	if name.OrganizationName and name.OrganizationName != name.LastName and name.OrganizationName != result:
+		if name.FirstName or name.LastName:
+			result += ", "
+		result += name.OrganizationName
+	return result
+
+	

gbdtransformation/commons/emap/template.yml

@@ -0,0 +1,55 @@
+# known issues:
+# Address lines do not have language codes => defaulting to application language code
+# Applicants/Representatives do not have an identifier
+# THTM: no MarkFeature => deduce
+# No Publication Section
+
+{% from 'navigation.tmpl' import match %}
+
+applicant:
+    identifier: {{ Applicant.ApplicantIdentifier }}
+    kind: {{ Applicant.ApplicantLegalEntity}}
+    fullName:
+      {% call(nameline) match('FormattedNameAddress.Name.FormattedName', Applicant.ApplicantAddressBook) %}
+      - text: {{ nameline | create_full_name }}
+        languageCode: {{ nameline.LastName | guess_language('en') }}
+      {% endcall %}
+    firstName:
+      {% call(nameline) match('FormattedNameAddress.Name.FormattedName.FirstName', Applicant.ApplicantAddressBook) %}
+      - languageCode: {{ nameline | guess_language('en') }}
+        text: {{ nameline }}
+      {% endcall %}
+    lastName:
+      {% call(nameline) match('FormattedNameAddress.Name.FormattedName.LastName', Applicant.ApplicantAddressBook) %}
+      - languageCode: {{ nameline | guess_language('en') }}
+        text: {{ nameline }}
+      {% endcall %}
+    middleName:
+      {% call(nameline) match('FormattedNameAddress.Name.FormattedName.MiddleName', Applicant.ApplicantAddressBook) %}
+      - languageCode: {{ nameline | guess_language('en') }}
+        text: {{ nameline }}
+      {% endcall %}
+    organizationName:
+      {% call(nameline) match('FormattedNameAddress.Name.FormattedName.OrganizationName', Applicant.ApplicantAddressBook) %}
+      - languageCode: {{ nameline | guess_language('en') }}
+        text: {{ nameline }}
+      {% endcall %}
+    fullAddress:
+      {% call(adrline) match('PostalAddress', Applicant.ApplicantAddressBook) %}
+      - text: {{ adrline }}
+        languageCode: {{ adrline | guess_language('en') }}
+      {% endcall %}
+    detailedAddress:
+      - languageCode: {{ Applicant.ApplicantAddressBook.FormattedNameAddress.Address.FormattedAddress.AddressStreet | guess_language('en') }}
+        text: {{ Applicant.ApplicantAddressBook.FormattedNameAddress.Address.FormattedAddress.AddressStreet }}
+        cityName: {{ Applicant.ApplicantAddressBook.FormattedNameAddress.Address.FormattedAddress.AddressCity }}
+        geographicRegionName: {{ Applicant.ApplicantAddressBook.FormattedNameAddress.Address.FormattedAddress.AddressState }}
+        postalCode: {{ Applicant.ApplicantAddressBook.FormattedNameAddress.Address.FormattedAddress.AddressPostcode }}
+    contact:
+      phone: {{ Applicant.ApplicantAddressBook.ContactInformationDetails.Phone }}
+      fax: {{ Applicant.ApplicantAddressBook.ContactInformationDetails.Fax }}
+      email: {{ Applicant.ApplicantAddressBook.ContactInformationDetails.Email }}
+      url: {{ Applicant.ApplicantAddressBook.ContactInformationDetails.URL }}
+    countryCode: {{ Applicant.ApplicantAddressBook.FormattedNameAddress.Address.AddressCountryCode }}
+
+ 

gbdtransformation/commons/emrp/__init__.py

@@ -0,0 +1 @@
+render = 'JSON'

gbdtransformation/commons/emrp/filters.py

@@ -0,0 +1,14 @@
+ignore_namespace = ['http://www.euipo.europa.eu/EUTM/EUTM_Download']
+
+def create_full_name(name): 
+	result = ""
+	
+	if name.FirstName: 
+		result += name.FirstName + " "
+	if name.LastName:
+		result += name.LastName
+	if name.OrganizationName and name.OrganizationName != name.LastName and name.OrganizationName != result:
+		if name.FirstName or name.LastName:
+			result += ", "
+		result += name.OrganizationName
+	return result

gbdtransformation/commons/emrp/template.yml

@@ -0,0 +1,53 @@
+# known issues:
+# Address lines do not have language codes => defaulting to application language code
+# Applicants/Representatives do not have an identifier
+# THTM: no MarkFeature => deduce
+# No Publication Section
+
+{% from 'navigation.tmpl' import match %}
+
+representative:
+    identifier: {{ Representative.RepresentativeIdentifier }}
+    kind: {{ Representative.RepresentativeLegalEntity}}
+    fullName:
+      {% call(nameline) match('FormattedNameAddress.Name.FormattedName', Representative.RepresentativeAddressBook) %}
+      - text: {{ nameline | create_full_name }}
+        languageCode: {{ nameline.LastName | guess_language('en') }}
+      {% endcall %}
+    firstName:
+      {% call(nameline) match('FormattedNameAddress.Name.FormattedName.FirstName', Representative.RepresentativeAddressBook) %}
+      - languageCode: {{ nameline | guess_language('en') }}
+        text: {{ nameline }}
+      {% endcall %}  
+    lastName:
+      {% call(nameline) match('FormattedNameAddress.Name.FormattedName.LastName', Representative.RepresentativeAddressBook) %}
+      - languageCode: {{ nameline | guess_language('en') }}
+        text: {{ nameline }}
+      {% endcall %}    
+    middleName:
+      {% call(nameline) match('FormattedNameAddress.Name.FormattedName.MiddleName', Representative.RepresentativeAddressBook) %}
+      - languageCode: {{ nameline | guess_language('en') }}
+        text: {{ nameline }}
+      {% endcall %}  
+    organizationName:
+      {% call(nameline) match('FormattedNameAddress.Name.FormattedName.OrganizationName', Representative.RepresentativeAddressBook) %}
+      - languageCode: {{ nameline | guess_language('en') }}
+        text: {{ nameline }}
+      {% endcall %}  
+    fullAddress:
+      {% call(adrline) match('PostalAddress', Representative.RepresentativeAddressBook) %}
+      - text: {{ adrline }}
+        languageCode: {{ adrline | guess_language('en') }}
+      {% endcall %}
+    detailedAddress:
+      - languageCode: {{ Representative.RepresentativeAddressBook.FormattedNameAddress.Address.FormattedAddress.AddressStreet | guess_language('en') }}
+        text: {{ Representative.RepresentativeAddressBook.FormattedNameAddress.Address.FormattedAddress.AddressStreet }}
+        cityName: {{ Representative.RepresentativeAddressBook.FormattedNameAddress.Address.FormattedAddress.AddressCity }}
+        geographicRegionName: {{ Representative.RepresentativeAddressBook.FormattedNameAddress.Address.FormattedAddress.AddressState }}
+        postalCode: {{ Representative.RepresentativeAddressBook.FormattedNameAddress.Address.FormattedAddress.AddressPostcode }}
+    contact:
+      phone: {{ Representative.RepresentativeAddressBook.ContactInformationDetails.Phone }}
+      fax: {{ Representative.RepresentativeAddressBook.ContactInformationDetails.Fax }}
+      email: {{ Representative.RepresentativeAddressBook.ContactInformationDetails.Email }}
+      url: {{ Representative.RepresentativeAddressBook.ContactInformationDetails.URL }}
+    countryCode: {{ Representative.RepresentativeAddressBook.FormattedNameAddress.Address.AddressCountryCode }}

gbdtransformation/commons/filters.py

@@ -0,0 +1,3 @@
+from gbdtransformation.common.filters import *
+
+ignore_namespace = ['http://www.euipo.europa.eu/EUTM/EUTM_Download']

gbdtransformation/designs/__init__.py

@@ -0,0 +1,8 @@
+status = ['Ended', 'Expired', 'Pending', 'Registered', 'Unknown', 'Delete']
+
+kinds = ['Industrial Design', 'Design patent']
+
+st13_identifier = \
+        { 'national': { 'design': '70'},
+          'multinational': { 'design': '70' }
+        }

gbdtransformation/designs/alid/__init__.py

@@ -0,0 +1,5 @@
+render = 'JSON'
+source = 'national'
+
+# AL/I/1996/000003
+appnum_mask = 'AL/[I|E|D]/\\d*/(\\d*)'

gbdtransformation/designs/alid/filters.py

@@ -0,0 +1,69 @@
+# standard gbd definitions
+import gbdtransformation.designs.ipas.filters as ipas
+
+
+# namespaces defined in XML and to be ignored in procecssing
+ignore_namespace = [
+   'http://www.wipo.int/standards/XMLSchema/designs',
+   'http://www.wipo.int/standards/XMLSchema/wo-designs'
+]
+def get_appdate(appdate, appnum):
+    return appnum.split('/')[-2]
+
+def get_designs_count(design, header):
+    return '1'
+
+def get_designs_pos(design, header):
+    return '1'
+
+def translate_kind(desgin, header):
+    code = header.TransactionCode.lower()
+    subcode = header.TransactionSubCode.lower()
+    if code == 'disenjo industriale':
+        return 'Industrial Design'
+    raise Exception('Type "%s" "%s" is not mapped.' % (code, subcode))
+
+def translate_status(design):
+    status = design.DesignCurrentStatusCode
+
+    if status == '2295': return 'Unknown'
+    if status == '2353': return 'Unknown'
+    if status == '2366': return 'Unknown'
+    if status == '2387': return 'Unknown'
+    if status == '2389': return 'Unknown'
+    if status == '2394': return 'Unknown'
+    if status == 'Reinstated': return 'Pending'
+
+    return ipas.translate_status(status)
+
+
+def get_registration_nb(design, idstatus):
+    if design.RegistrationNumber:
+        return design.RegistrationNumber
+
+    return None
+
+
+def get_expiry_date(design, idstatus):
+    return ipas.get_expiry_date(design, idstatus)
+
+def get_registration_date(design, idstatus):
+    return ipas.get_registration_date(design, idstatus)
+
+def is_international(header):
+    return False
+
+def get_ir_refnum(appnum):
+    return appnum
+
+def select_earliest_date(publications):
+    return ipas.select_earliest_date(publications)
+
+def deduplicate_publication_dates(publications):
+    return ipas.deduplicate_publication_dates(publications)
+
+def deduplicate_classes(classes):
+    return ipas.deduplicate_classes(classes)
+
+def deduplicate_publications(publications):
+    return ipas.deduplicate_publications(publications)

gbdtransformation/designs/alid/schema

@@ -0,0 +1,89 @@
+/Transaction
+__/DesignTransactionBody
+____/TransactionContentDetails
+______/TransactionCode
+______/TransactionData
+________/DesignApplicationDetails
+__________/DesignApplication
+____________/ApplicantDetails
+______________/ApplicantKey
+____________/DesignApplicationDate
+____________/DesignApplicationLanguageCode
+____________/DesignApplicationNumber
+____________/DesignDetails
+______________/Design
+________________/ApplicantDetails
+__________________/Applicant
+____________________/ApplicantAddressBook
+______________________/FormattedNameAddress
+________________________/Address
+__________________________/AddressCountryCode
+__________________________/FreeFormatAddress
+____________________________/FreeFormatAddressLine
+________________________/Name
+__________________________/FreeFormatName
+____________________________/FreeFormatNameDetails
+______________________________/FreeFormatNameLine
+______________________________/FreeFormatNameLine[@languageCode=sq]
+________________/DesignCurrentStatusCode
+________________/DesignCurrentStatusDate
+________________/DesignDescription
+________________/DesignIdentifier
+________________/DesignRepresentationSheetDetails
+__________________/DesignRepresentationSheet
+____________________/RepresentationSheetFilename
+________________/DesignTitle
+________________/DesignTitle[@languageCode=sq]
+________________/DesignTitle[@sequenceNumber=1]
+________________/DesignerDetails
+__________________/Designer
+____________________/DesignerAddressBook
+______________________/FormattedNameAddress
+________________________/Address
+__________________________/AddressCountryCode
+__________________________/FreeFormatAddress
+____________________________/FreeFormatAddressLine
+________________________/Name
+__________________________/FreeFormatName
+____________________________/FreeFormatNameDetails
+______________________________/FreeFormatNameLine
+______________________________/FreeFormatNameLine[@languageCode=sq]
+________________/ExpiryDate
+________________/IndicationProductDetails
+__________________/IndicationProduct
+____________________/ClassDescriptionDetails
+______________________/ClassDescription
+________________________/ClassNumber
+________________________/ProductDescription
+____________________/ClassificationKindCode
+____________________/ClassificationVersion
+________________/NoveltyStatement
+________________/NoveltyStatement[@languageCode=]
+________________/NoveltyStatement[@languageCode=sq]
+________________/PriorityDetails
+__________________/Priority
+____________________/PriorityCountryCode
+____________________/PriorityDate
+____________________/PriorityNumber
+________________/PublicationDetails
+__________________/Publication
+____________________/PublicationDate
+____________________/PublicationIdentifier
+________________/RegistrationDate
+________________/RegistrationNumber
+________________/RepresentativeDetails
+__________________/Representative
+____________________/RepresentativeAddressBook
+______________________/FormattedNameAddress
+________________________/Address
+__________________________/AddressCountryCode
+__________________________/FreeFormatAddress
+____________________________/FreeFormatAddressLine
+________________________/Name
+__________________________/FreeFormatName
+____________________________/FreeFormatNameDetails
+______________________________/FreeFormatNameLine
+______________________________/FreeFormatNameLine[@languageCode=sq]
+____________/RegistrationOfficeCode
+______/TransactionIdentifier
+______/TransactionSubCode

gbdtransformation/designs/alid/template.yml

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

gbdtransformation/designs/bnid/__init__.py

@@ -0,0 +1,5 @@
+render = 'JSON'
+source = 'national'
+
+# AL/I/1996/000003
+appnum_mask = 'BN/\\d*/(\\d*)'

gbdtransformation/designs/bnid/filters.py

@@ -0,0 +1,61 @@
+# standard gbd definitions
+import gbdtransformation.designs.ipas.filters as ipas
+
+
+# namespaces defined in XML and to be ignored in procecssing
+ignore_namespace = [
+   'http://www.wipo.int/standards/XMLSchema/designs',
+   'http://www.wipo.int/standards/XMLSchema/wo-designs'
+]
+def get_appdate(appdate, appnum):
+    return appnum.split('/')[-2]
+
+def get_designs_count(design, header):
+    return '1'
+
+def get_designs_pos(design, header):
+    return '1'
+
+def translate_kind(desgin, header):
+    code = header.TransactionCode.lower()
+    subcode = header.TransactionSubCode.lower()
+    if code == 'industrial design':
+        return 'Industrial Design'
+    raise Exception('Type "%s" "%s" is not mapped.' % (code, subcode))
+
+def translate_status(design):
+    status = design.DesignCurrentStatusCode
+
+    return ipas.translate_status(status)
+
+
+def get_registration_nb(design, idstatus):
+    if design.RegistrationNumber:
+        return design.RegistrationNumber
+
+    return None
+
+
+def get_expiry_date(design, idstatus):
+    return ipas.get_expiry_date(design, idstatus)
+
+def get_registration_date(design, idstatus):
+    return ipas.get_registration_date(design, idstatus)
+
+def is_international(header):
+    return False
+
+def get_ir_refnum(appnum):
+    return appnum
+
+def select_earliest_date(publications):
+    return ipas.select_earliest_date(publications)
+
+def deduplicate_publication_dates(publications):
+    return ipas.deduplicate_publication_dates(publications)
+
+def deduplicate_classes(classes):
+    return ipas.deduplicate_classes(classes)
+
+def deduplicate_publications(publications):
+    return ipas.deduplicate_publications(publications)

gbdtransformation/designs/bnid/schema

@@ -0,0 +1,80 @@
+/Transaction
+__/DesignTransactionBody
+____/TransactionContentDetails
+______/TransactionCode
+______/TransactionData
+________/DesignApplicationDetails
+__________/DesignApplication
+____________/ApplicantDetails
+______________/ApplicantKey
+____________/DesignApplicationDate
+____________/DesignApplicationLanguageCode
+____________/DesignApplicationNumber
+____________/DesignDetails
+______________/Design
+________________/ApplicantDetails
+__________________/Applicant
+____________________/ApplicantAddressBook
+______________________/FormattedNameAddress
+________________________/Address
+__________________________/AddressCountryCode
+__________________________/FreeFormatAddress
+____________________________/FreeFormatAddressLine
+________________________/Name
+__________________________/FreeFormatName
+____________________________/FreeFormatNameDetails
+______________________________/FreeFormatNameLine
+______________________________/FreeFormatNameLine[@languageCode=en]
+________________/DesignCurrentStatusCode
+________________/DesignCurrentStatusDate
+________________/DesignDescription
+________________/DesignEventDetails
+__________________/DesignEvent
+____________________/DesignEventCode
+____________________/DesignEventDate
+____________________/OfficeSpecificDesignEventCode
+____________________/OfficeSpecificDesignEventDescription
+____________________/OfficeSpecificDesignEventDescription[@languageCode=en]
+________________/DesignIdentifier
+________________/DesignRepresentationSheetDetails
+__________________/DesignRepresentationSheet
+____________________/RepresentationSheetFilename
+________________/DesignTitle
+________________/DesignTitle[@languageCode=en]
+________________/DesignTitle[@sequenceNumber=1]
+________________/IndicationProductDetails
+__________________/IndicationProduct
+____________________/ClassDescriptionDetails
+______________________/ClassDescription
+________________________/ClassNumber
+________________________/ProductDescription
+____________________/ClassificationKindCode
+____________________/ClassificationVersion
+________________/NoveltyStatement
+________________/NoveltyStatement[@languageCode=en]
+________________/PriorityDetails
+__________________/Priority
+____________________/PriorityCountryCode
+____________________/PriorityDate
+____________________/PriorityNumber
+________________/PublicationDetails
+__________________/Publication
+____________________/PublicationDate
+________________/RegistrationDate
+________________/RegistrationNumber
+________________/RepresentativeDetails
+__________________/Representative
+____________________/RepresentativeAddressBook
+______________________/FormattedNameAddress
+________________________/Address
+__________________________/AddressCountryCode
+__________________________/FreeFormatAddress
+____________________________/FreeFormatAddressLine
+________________________/Name
+__________________________/FreeFormatName
+____________________________/FreeFormatNameDetails
+______________________________/FreeFormatNameLine
+______________________________/FreeFormatNameLine[@languageCode=en]
+____________/RegistrationOfficeCode
+______/TransactionIdentifier
+______/TransactionSubCode

gbdtransformation/designs/bnid/template.yml

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

gbdtransformation/designs/bwid/__init__.py

@@ -0,0 +1,6 @@
+render = 'JSON'
+source = 'national'
+
+# AL/I/1996/000003
+appnum_mask = ['BWBW([F|P])\\d{4}(\\d*)',
+               'BWAP([F|P])\\d{4}(\\d*)']