rue-a / provo Goto Github PK

Currently, many default values are set to None by proxy (e.g., "", [], {}) to be compliant with the given type hint, e.g.

def method(in: str = "", in_2: list = []) -> str:
    <...>
    if <something>:
        return "some string"
    else:
        return ""

instead of:

def method(in: str = None, in_2: list = None) -> str:
    <...>
    if <something>:
        return "some string"
    else:
        return None

According to PyLint some of these default values may be harmful:

dangerous-default-value / W0102

Message emitted:

Dangerous default value %s as argument

Description:

Used when a mutable value as list or dictionary is detected in a default value for an argument.

Problematic code:

def whats\_on\_the\_telly(penguin\=\[\]):  \# \[dangerous-default-value\]
   penguin.append("property of the zoo")
   return penguin

Correct code:

def whats\_on\_the\_telly(penguin\=None):
   if penguin is None:
       penguin \= \[\]
   penguin.append("property of the zoo")
   return penguin

Additional details:

With a mutable default value, with each call the default value is modified, i.e.:

whats\_on\_the\_telly() \# \["property of the zoo"\]
whats\_on\_the\_telly() \# \["property of the zoo", "property of the zoo"\]
whats\_on\_the\_telly() \# \["property of the zoo", "property of the zoo", "property of the zoo"\]

Currently, you create a PROV object by providing the graph to which it should be added as argument (among other args). Change this, so that the PROV object creation is controlled by class methods of the ProvGraph class.

provGraph = ProvGraph('https://ex.org/')
entity = provGraph.addEntity(id = '...')

instead of

provGraph = ProvGraph('https://ex.org/')
entity = Entity(provGraph, id = '...')

Most classes are defined in provClasses.py. Refactor to one file per class!

Update examples and review text thoroughly.

Add export capabilities for image formats.

• include DPI option
• include image size option

"ProvStore is a free service for storing, viewing and collaborating on provenance documents."

Export should be fairly easy to implement. Import probably requires integration of the full PROV-Data Model.

Currently, the package uses Pythons internal datetime package. This has not the full capabilities of http://www.w3.org/2001/XMLSchema#dateTime, e.g., it cannot represent negative dates.

Handle PROV-O graph construction in the ProvGraph class (rather than directly using rdflib functions). Add serialize function that exports the model in different formats.

Currently, the ProvGraph Class only know the PROV-O starting terms. This makes sense for simple applications or for users that are new to the PROV DM.

Implement a derived class that also implements the advanced terms of the PROV-DM.