schrodinger.application.canvas.utils module¶
Canvas utility functions.
Copyright Schrodinger, LLC. All rights reserved.
-
schrodinger.application.canvas.utils.strip_r(file_name)¶
-
class
schrodinger.application.canvas.utils.chm_excel¶ Bases:
csv.excel-
delimiter= ','¶
-
quotechar= '"'¶
-
doublequote= True¶
-
skipinitialspace= False¶
-
lineterminator= '\n'¶
-
quoting= 0¶
-
__class__¶ alias of
builtins.type
-
__delattr__¶ Implement delattr(self, name).
-
__dict__= mappingproxy({'__module__': 'schrodinger.application.canvas.utils', 'delimiter': ',', 'quotechar': '"', 'doublequote': True, 'skipinitialspace': False, 'lineterminator': '\n', 'quoting': 0, '__doc__': None})¶
-
__dir__() → list¶ default dir() implementation
-
__eq__¶ Return self==value.
-
__format__()¶ default object formatter
-
__ge__¶ Return self>=value.
-
__getattribute__¶ Return getattr(self, name).
-
__gt__¶ Return self>value.
-
__hash__¶ Return hash(self).
-
__init__()¶ Initialize self. See help(type(self)) for accurate signature.
-
__init_subclass__()¶ This method is called when a class is subclassed.
The default implementation does nothing. It may be overridden to extend subclasses.
-
__le__¶ Return self<=value.
-
__lt__¶ Return self<value.
-
__module__= 'schrodinger.application.canvas.utils'¶
-
__ne__¶ Return self!=value.
-
__new__()¶ Create and return a new object. See help(type) for accurate signature.
-
__reduce__()¶ helper for pickle
-
__reduce_ex__()¶ helper for pickle
-
__repr__¶ Return repr(self).
-
__setattr__¶ Implement setattr(self, name, value).
-
__sizeof__() → int¶ size of object in memory, in bytes
-
__str__¶ Return str(self).
-
__subclasshook__()¶ Abstract classes can override this to customize issubclass().
This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).
-
__weakref__¶ list of weak references to the object (if defined)
-
escapechar= None¶
-
-
class
schrodinger.application.canvas.utils.chm_bluebird¶ Bases:
csv.excel-
delimiter= '\t'¶
-
quotechar= '"'¶
-
doublequote= True¶
-
skipinitialspace= False¶
-
lineterminator= '\t\n'¶
-
quoting= 3¶
-
__class__¶ alias of
builtins.type
-
__delattr__¶ Implement delattr(self, name).
-
__dict__= mappingproxy({'__module__': 'schrodinger.application.canvas.utils', 'delimiter': '\t', 'quotechar': '"', 'doublequote': True, 'skipinitialspace': False, 'lineterminator': '\t\n', 'quoting': 3, '__doc__': None})¶
-
__dir__() → list¶ default dir() implementation
-
__eq__¶ Return self==value.
-
__format__()¶ default object formatter
-
__ge__¶ Return self>=value.
-
__getattribute__¶ Return getattr(self, name).
-
__gt__¶ Return self>value.
-
__hash__¶ Return hash(self).
-
__init__()¶ Initialize self. See help(type(self)) for accurate signature.
-
__init_subclass__()¶ This method is called when a class is subclassed.
The default implementation does nothing. It may be overridden to extend subclasses.
-
__le__¶ Return self<=value.
-
__lt__¶ Return self<value.
-
__module__= 'schrodinger.application.canvas.utils'¶
-
__ne__¶ Return self!=value.
-
__new__()¶ Create and return a new object. See help(type) for accurate signature.
-
__reduce__()¶ helper for pickle
-
__reduce_ex__()¶ helper for pickle
-
__repr__¶ Return repr(self).
-
__setattr__¶ Implement setattr(self, name, value).
-
__sizeof__() → int¶ size of object in memory, in bytes
-
__str__¶ Return str(self).
-
__subclasshook__()¶ Abstract classes can override this to customize issubclass().
This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).
-
__weakref__¶ list of weak references to the object (if defined)
-
escapechar= None¶
-
-
class
schrodinger.application.canvas.utils.ChmCSVTools(default_format_in=None, default_format_out=None, case_sensitive=True)¶ Bases:
object-
__init__(default_format_in=None, default_format_out=None, case_sensitive=True)¶ Initialize self. See help(type(self)) for accurate signature.
-
dictValues(dict, key_list=[], action_remove=False)¶
-
dictKeys(dict, key_list=[], action_remove=False)¶
-
getHeader(source_file, dialect=None, one_based=False)¶
-
rewrite(source_file, dest_file, header_substitutions={}, dialect=None)¶
-
rewriteByIndex(source_file, dest_file, column_indices=[], dialect_in=None, dialect_out=None, one_based=False, action_remove=False)¶
-
mergeByIndex(source_file1, source_file2, dest_file, column_indices_file1=[], column_indices_file2=[], dialect_in1=None, dialect_in2=None, dialect_out=None, one_based=False, action_remove=False)¶
-
__class__¶ alias of
builtins.type
-
__delattr__¶ Implement delattr(self, name).
-
__dict__= mappingproxy({'__module__': 'schrodinger.application.canvas.utils', '__init__': <function ChmCSVTools.__init__>, 'dictValues': <function ChmCSVTools.dictValues>, 'dictKeys': <function ChmCSVTools.dictKeys>, 'getHeader': <function ChmCSVTools.getHeader>, 'rewrite': <function ChmCSVTools.rewrite>, 'rewriteByIndex': <function ChmCSVTools.rewriteByIndex>, 'mergeByIndex': <function ChmCSVTools.mergeByIndex>, 'mergeByName': <function ChmCSVTools.mergeByName>, '__dict__': <attribute '__dict__' of 'ChmCSVTools' objects>, '__weakref__': <attribute '__weakref__' of 'ChmCSVTools' objects>, '__doc__': None})¶
-
__dir__() → list¶ default dir() implementation
-
__eq__¶ Return self==value.
-
__format__()¶ default object formatter
-
__ge__¶ Return self>=value.
-
__getattribute__¶ Return getattr(self, name).
-
__gt__¶ Return self>value.
-
__hash__¶ Return hash(self).
-
__init_subclass__()¶ This method is called when a class is subclassed.
The default implementation does nothing. It may be overridden to extend subclasses.
-
__le__¶ Return self<=value.
-
__lt__¶ Return self<value.
-
__module__= 'schrodinger.application.canvas.utils'¶
-
__ne__¶ Return self!=value.
-
__new__()¶ Create and return a new object. See help(type) for accurate signature.
-
__reduce__()¶ helper for pickle
-
__reduce_ex__()¶ helper for pickle
-
__repr__¶ Return repr(self).
-
__setattr__¶ Implement setattr(self, name, value).
-
__sizeof__() → int¶ size of object in memory, in bytes
-
__str__¶ Return str(self).
-
__subclasshook__()¶ Abstract classes can override this to customize issubclass().
This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).
-
__weakref__¶ list of weak references to the object (if defined)
-
mergeByName(source_file1, source_file2, dest_file, column_names1=[], column_names2=[], dialect_in1=None, dialect_in2=None, dialect_out=None, action_remove=False)¶
-
-
schrodinger.application.canvas.utils.get_license(license_type='LICENSE_FULL')¶ Instantiate a valid Canvas license object or raise an Exception.
Parameters: license_type (A module-level constant: LICENSE_FULL, LICENSE_SHARED, or LICENSE_FULL_OR_MAIN. Default is LICENSE_FULL.) – The type of license to request. Raises: Exception when the license_type isn’t recognized or the requested license is not valid.