wipo-gbd-transformation 1.1.46__py3-none-any.whl → 1.1.59__py3-none-any.whl

gbdtransformation/designs/egid/filters.py

@@ -0,0 +1,62 @@
+# 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 appdate
+
+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 == 'نموذج صناعي':
+        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/egid/schema

@@ -0,0 +1,82 @@
+/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=ar]
+________________/DesignCurrentStatusCode
+________________/DesignCurrentStatusDate
+________________/DesignDescription
+________________/DesignIdentifier
+________________/DesignRepresentationSheetDetails
+__________________/DesignRepresentationSheet
+____________________/RepresentationSheetFilename
+________________/DesignSpecimenDetails
+__________________/DesignSpecimen
+____________________/SpecimenDescription
+____________________/SpecimenDescription[@languageCode=ar]
+____________________/SpecimenIdentifier
+________________/DesignTitle
+________________/DesignTitle[@languageCode=ar]
+________________/DesignTitle[@languageCode=en]
+________________/DesignTitle[@sequenceNumber=1]
+________________/ExpiryDate
+________________/IndicationProductDetails
+__________________/IndicationProduct
+____________________/ClassDescriptionDetails
+______________________/ClassDescription
+________________________/ClassNumber
+________________________/ProductDescription
+____________________/ClassificationKindCode
+____________________/ClassificationVersion
+________________/NoveltyStatement
+________________/NoveltyStatement[@languageCode=ar]
+________________/NoveltyStatement[@languageCode=en]
+________________/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=ar]
+____________/RegistrationOfficeCode
+______/TransactionIdentifier
+______/TransactionSubCode

gbdtransformation/designs/egid/template.yml

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

gbdtransformation/designs/filters.py

@@ -0,0 +1,73 @@
+import re
+from gbdtransformation.designs import st13_identifier
+from gbdtransformation.common.filters import *
+
+def parseStatus(status):
+    """ Function is here to be overriden in child elements( e.g BRTM)"""
+    return status
+
+def pad_locarno(data, separator='-'):
+    """Convert to locarno style with padding"""
+    if separator in data:
+        slice = data.split(separator)
+        return slice[0].zfill(2) + '-' + pad_locarno('-'.join(slice[1:]))
+    return data.zfill(2)
+
+def should_display_language(lang, payload):
+    if payload:
+        return lang
+    return None
+
+def st13(appnum, registration_number, office, pos, type='Design', appdate=None, roffice=None, sanitize=True):
+    if not appnum:
+        # fallback to registration number (required for example by Hague pre-1999 records, which have no application number)
+        if registration_number:
+            # remove non digit prefix (we want to keep non digit char at the end of the registration number, to distinguish
+            # non unitary registration numbers from the same application, e.g. D054966 and D054966A)
+            registration_number = re.sub(r"^[^0-9]+", '', registration_number)
+            appnum = 'R' + registration_number
+        else:
+            return None
+    # collections are usually office code followed with tm: xxtm
+    collection = '%sid' % office.lower()
+
+    module_pckg = load_collection_package('designs', collection)
+    try:
+        masks = getattr(module_pckg, 'appnum_mask')
+        if not isinstance(masks, list): masks = [masks]
+    except:
+        masks = ['(.*)']
+
+    try:
+        source = getattr(module_pckg, 'source')
+    except:
+        source = 'national'
+    matches = None
+    for mask in masks:
+        regex = re.compile('^%s$' % mask)
+        matches = regex.search(appnum)
+        if matches:
+            break
+
+    if not matches:
+        raise Exception('could not apply appnum mask %s on %s' % (mask, appnum))
+
+    #print(appnum, ''.join(matches.groups()))
+    appnum = ''.join(matches.groups())
+
+    prefix = st13_identifier[source.lower()][type.lower()]
+    if sanitize:
+        # remove special characters
+        special_chars = re.compile(r'\W')
+        appnum = special_chars.sub('', appnum)
+
+    # reference office (only relevant for inerantional)
+    if roffice and roffice != office:
+        appnum = '%s%s' % (roffice.upper(), appnum)
+
+    st13 = '%s%s' % (office.upper(), prefix)
+    if appdate:
+        st13 = '%s%s' % (st13, appdate[:4])
+
+    # add application number and zfill till 17
+    return '%s%s' % (st13, appnum.zfill(17 - len(st13)))

gbdtransformation/designs/idid/__init__.py

@@ -0,0 +1,5 @@
+render = 'JSON'
+source = 'national'
+
+# AID2018000076
+appnum_mask = ['A(\\d*)', 'AID\\d{4}(\\d*)']

gbdtransformation/designs/idid/filters.py

@@ -0,0 +1,67 @@
+# standard gbd definitions
+import gbdtransformation.designs.ipas.filters as ipas
+import re
+
+# 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):
+    mask = 'AID(\\d{4})\\d*'
+    regex = re.compile('^%s$' % mask)
+    matches = regex.search(appnum)
+    if matches:
+        return ''.join(matches.groups())
+    return appdate
+
+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 == 'desain industri':
+        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/idid/schema

@@ -0,0 +1,102 @@
+/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=in]
+________________/DesignCurrentStatusCode
+________________/DesignCurrentStatusDate
+________________/DesignDescription
+________________/DesignEventDetails
+__________________/DesignEvent
+____________________/DesignEventCode
+____________________/DesignEventDate
+____________________/OfficeSpecificDesignEventCode
+____________________/OfficeSpecificDesignEventDescription
+____________________/OfficeSpecificDesignEventDescription[@languageCode=in]
+____________________/OfficeSpecificDesignEventName
+________________/DesignIdentifier
+________________/DesignRepresentationSheetDetails
+__________________/DesignRepresentationSheet
+____________________/RepresentationSheetFilename
+________________/DesignSpecimenDetails
+__________________/DesignSpecimen
+____________________/SpecimenDescription
+____________________/SpecimenDescription[@languageCode=in]
+____________________/SpecimenIdentifier
+________________/DesignTitle
+________________/DesignTitle[@languageCode=in]
+________________/DesignTitle[@sequenceNumber=1]
+________________/DesignerDetails
+__________________/Designer
+____________________/DesignerAddressBook
+______________________/FormattedNameAddress
+________________________/Address
+__________________________/AddressCountryCode
+__________________________/FreeFormatAddress
+____________________________/FreeFormatAddressLine
+________________________/Name
+__________________________/FreeFormatName
+____________________________/FreeFormatNameDetails
+______________________________/FreeFormatNameLine
+______________________________/FreeFormatNameLine[@languageCode=in]
+________________/ExpiryDate
+________________/IndicationProductDetails
+__________________/IndicationProduct
+____________________/ClassDescriptionDetails
+______________________/ClassDescription
+________________________/ClassNumber
+________________________/ProductDescription
+____________________/ClassificationKindCode
+____________________/ClassificationVersion
+________________/NoveltyStatement
+________________/NoveltyStatement[@languageCode=]
+________________/NoveltyStatement[@languageCode=in]
+________________/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=in]
+____________/RegistrationOfficeCode
+______/TransactionIdentifier
+______/TransactionSubCode

gbdtransformation/designs/idid/template.yml

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

gbdtransformation/designs/ipas/filters.py

@@ -1,7 +1,6 @@
-# standard gbd definitions
+# standard gdd definitions
 from gbdtransformation.designs import kinds as std_kinds
 from gbdtransformation.designs import status as std_status
-from gbdtransformation.brands import events as std_events
 
 # namespaces defined in XML and to be ignored in procecssing
 ignore_namespace = []
@@ -65,6 +64,89 @@ def get_registration_date(trademark, tmstatus):
             if event.MarkEventCode == 'Published':
                 return event.MarkEventDate
 
+# given a list of dates as strings, e.g. publication dates, deduplicate
+def deduplicate_dates(dates):
+    return list(set(dates))
+
+# given a list of publications, deduplicate
+def deduplicate_publication_dates(design):
+    if design == None:
+        return None
+    dates = []
+    if "PublicationDetails" in design:
+        publicationDetails = design["PublicationDetails"]
+        publications = publicationDetails.get('Publication', [])
+        if not isinstance(publications, list): 
+            publications = [publications]
+        for publication in publications:
+            if "PublicationDate" in publication:
+                dates.append(publication["PublicationDate"])
+    return deduplicate_dates(dates)
+
+# given a list of classes, deduplicate
+def deduplicate_classes(classes):
+    deduplicate_classes = []
+    if not isinstance(classes, list): 
+        classes = [classes]
+    for the_class in classes:
+        if the_class["ClassNumber"] not in deduplicate_classes:
+            deduplicate_classes.append(the_class["ClassNumber"])
+    result = []
+    for deduplicate_class in deduplicate_classes:
+        result.append({ "code": deduplicate_class} )
+    return result
+
+# given a list of publications, deduplicate
+def deduplicate_publications(publications):
+    deduplicate_publications = []
+    pub_keys = []
+    if not isinstance(publications, list): 
+        publications = [publications]
+    for publication in publications:
+        publication_date = publication.get("PublicationDate")
+        publication_identifier = publication.get("PublicationIdentifier")
+        pub_key = ""
+        if publication_identifier:
+            pub_key += publication_identifier
+        if publication_date:
+            pub_key += publication_date
+        if pub_key not in pub_keys:
+            deduplicate_publications.append(publication)
+            pub_keys.append(pub_key)
+    result = []
+    for publication in deduplicate_publications:
+        res = {}
+        if "PublicationIdentifier" in publication:
+            res["identifier"] = publication["PublicationIdentifier"]
+        if "PublicationDate" in publication:
+            res["date"] = publication["PublicationDate"]
+        result.append(res)
+    return result
+
+# given a list of publications with dates as strings, select the earliest date publication
+def select_earliest_date(design):
+    if design == None:
+        return None
+
+    if "PublicationDetails" in design:
+        publicationDetails = design["PublicationDetails"]
+        publications = publicationDetails.get('Publication', [])
+        if not isinstance(publications, list): 
+            publications = [publications]
+        if len(publications) == 0:
+            return None
+        elif len(publications) == 1:
+            return publications[0]["PublicationDate"]
+        else:
+            earliest_date = None
+            n = -1
+            for count, publication in enumerate(publications):
+                if earliest_date == None or publication["PublicationDate"] < earliest_date:
+                    earliest_date = publication["PublicationDate"]
+            return earliest_date
+    else:
+        return None
+
 def translate_status(status):
     status = status.lower()