-"""
-A module containing the base class for all writers.
-
-...
-
-Classes
--------
-BaseWriter
- A base class for all writers.
-"""
-
-importsys
-importos
-
-
-
-[docs]
-classBaseWriter:
-"""
- A base class for all writers.
-
- ...
-
- Attributes
- ----------
- file : file
- The file to write to.
- mode : str
- The mode of the file. Either 'w' for write or 'a' for append.
- filename : str
- The name of the file to write to. If None, the output is printed to stdout.
- """
-
- def__init__(self,filename:str=None,mode:str='w'):
-"""
- It sets the file to write to - either a file or stdout (if filename is None) - and the mode of the file.
-
- Parameters
- ----------
- filename : str
- The name of the file to write to. If None, the output is printed to stdout.
- mode : str
- The mode of the file. Either 'w' for write or 'a' for append.
-
- Raises
- ------
- ValueError
- If the given mode is not 'w' or 'a'.
- ValueError
- If the given filename already exists and the mode is 'w'.
- """
- ifmodenotin['w','a']:
- raiseValueError('Invalid mode - has to be either \'w\' or \'a\'.')
- elifmode=='w'andfilenameisnotNoneandos.path.isfile(filename):
- raiseValueError(
- f"File {filename} already exists. Use mode \'a\' to append to file.")
-
- iffilenameisNone:
- self.file=sys.stdout
- else:
- self.file=None
-
- self.mode='a'
- self.filename=filename
-
-
-[docs]
- defopen(self):
-"""
- Opens the file to write to.
- """
- ifself.filenameisnotNone:
- self.file=open(self.filename,self.mode)
-
-
-
-[docs]
- defclose(self):
-"""
- Closes the file to write to.
- """
- ifself.fileisnotNoneandself.filenameisnotNone:
- self.file.close()
-
- self.file=None
-"""
-A module containing different decorators which could be useful.
-"""
-
-fromcollectionsimportdefaultdict
-
-
-
-[docs]
-defcount_decorator(func):
-"""
- Decorator which counts the number of times a function is called.
- """
- defwrapper(*args,**kwargs):
- wrapper.counter+=1
- reset_counter=kwargs.get('reset_counter')
-
- ifreset_counter:
- wrapper.counter=1
-
- returnfunc(*args,**kwargs)
- wrapper.counter=0
- returnwrapper
-
-
-
-
-[docs]
-definstance_function_count_decorator(func):
-"""
- Decorator which counts the number of times a function is called for an instance of a class.
- """
-
- defnew_func(self,*args,**kwargs):
- ifnothasattr(self,'counter'):
- setattr(self,'counter',defaultdict(int))
- self.counter[func.__name__]+=1
-
- reset_counter=kwargs.get('reset_counter')
-
- ifreset_counter:
- self.counter[func.__name__]=1
-
- func(self,*args,**kwargs)
- new_func.__name__=func.__name__
- returnnew_func
-"""
-A module containing different exceptions which could be useful.
-"""
-
-
-
-[docs]
-classElementNotFoundError(Exception):
-"""
- Exception raised if the given element id is not valid
- """
-
- def__init__(self,id):
- self.id=id
- self.message=f"""Element with id {
-self.id} is not a valid element identifier."""
- super().__init__(self.message)
