pycrossword  0.2
Pure-Python implementation of a crossword puzzle generator and editor
Classes | Functions | Variables
pycross.utils.utils Namespace Reference

Classes

class  JsonHiliter
 Syntax highlighter class for JSON. More...
 
class  QThreadStump
 

Functions

def is_iterable (obj)
 
def getosname ()
 
def generate_uuid ()
 
def walk_dir (root_path, abs_path=True, recurse=True, dir_process_function=None, file_process_function=None, file_types=None)
 
def run_exe (args, external=False, capture_output=True, stdout=subprocess.PIPE, encoding=ENCODING, timeout=None, shell=False, **kwargs)
 
def datetime_to_str (dt=None, strformat='%Y-%m-%d %H-%M-%S')
 
def timestamp_to_str (ts=None, strformat='%Y-%m-%d %H-%M-%S')
 
def str_to_datetime (text, strformat='%Y-%m-%d %H-%M-%S')
 
def str_to_timestamp (text, strformat='%Y-%m-%d %H-%M-%S')
 
def get_tempdir ()
 
def bytes_human (value, suffix='B')
 
def restart_app (closefunction)
 
def file_types_registered (filetypes=('xpf', 'ipuz', 'pxjson'))
 
def register_file_types (filetypes=('xpf', 'ipuz', 'pxjson'), register=True)
 
def make_font (family, size=-1, weight=-1, italic=False, font_unit='pt')
 
def MsgBox (what, parent=None, title='pyCross', msgtype='info', btn=None, detailedText='', infoText='', execnow=True)
 
def UserInput (dialogtype='text', parent=None, title='pyCross', label='', value=None, textmode='normal', valrange=None, decimals=1, step=1, comboeditable=True, comboitems=[])
 
def clipboard_copy (value, valtype='text')
 
def clipboard_get (valtype='text')
 
def clipboard_clear ()
 
def stylesheet_load (style, dequote=True, strip_sz=True, units=('pt', 'px'))
 
def stylesheet_dump (d, quoted_keys=('font-family',), add_units={ 'font-size':'pt', 'border':'px', 'border-width':'px'})
 
def font_weight_css2qt (weight, default=0)
 
def font_weight_qt2css (weight, default=0)
 
def font_from_stylesheet (style, font_unit='pt', default_font=None)
 
def font_to_stylesheet (font, style, font_unit='pt')
 
def color_from_stylesheet (style, tag='background-color', default='black')
 
def color_to_stylesheet (color, style, tag='background-color')
 
def property_to_stylesheet (propname, propvalue, style)
 
def property_from_stylesheet (propname, style, default=None)
 

Variables

dictionary MSGBOX_BUTTONS
 
dictionary MSGBOX_TYPES
 

Function Documentation

◆ bytes_human()

def pycross.utils.utils.bytes_human (   value,
  suffix = 'B' 
)

◆ clipboard_clear()

def pycross.utils.utils.clipboard_clear ( )

◆ clipboard_copy()

def pycross.utils.utils.clipboard_copy (   value,
  valtype = 'text' 
)

◆ clipboard_get()

def pycross.utils.utils.clipboard_get (   valtype = 'text')

◆ color_from_stylesheet()

def pycross.utils.utils.color_from_stylesheet (   style,
  tag = 'background-color',
  default = 'black' 
)

◆ color_to_stylesheet()

def pycross.utils.utils.color_to_stylesheet (   color,
  style,
  tag = 'background-color' 
)

◆ datetime_to_str()

def pycross.utils.utils.datetime_to_str (   dt = None,
  strformat = '%Y-%m-%d %H-%M-%S' 
)

◆ file_types_registered()

def pycross.utils.utils.file_types_registered (   filetypes = ('xpf', 'ipuz', 'pxjson'))

◆ font_from_stylesheet()

def pycross.utils.utils.font_from_stylesheet (   style,
  font_unit = 'pt',
  default_font = None 
)

◆ font_to_stylesheet()

def pycross.utils.utils.font_to_stylesheet (   font,
  style,
  font_unit = 'pt' 
)

◆ font_weight_css2qt()

def pycross.utils.utils.font_weight_css2qt (   weight,
  default = 0 
)

◆ font_weight_qt2css()

def pycross.utils.utils.font_weight_qt2css (   weight,
  default = 0 
)

◆ generate_uuid()

def pycross.utils.utils.generate_uuid ( )

◆ get_tempdir()

def pycross.utils.utils.get_tempdir ( )

◆ getosname()

def pycross.utils.utils.getosname ( )

◆ is_iterable()

def pycross.utils.utils.is_iterable (   obj)

◆ make_font()

def pycross.utils.utils.make_font (   family,
  size = -1,
  weight = -1,
  italic = False,
  font_unit = 'pt' 
)

◆ MsgBox()

def pycross.utils.utils.MsgBox (   what,
  parent = None,
  title = 'pyCross',
  msgtype = 'info',
  btn = None,
  detailedText = '',
  infoText = '',
  execnow = True 
)

◆ property_from_stylesheet()

def pycross.utils.utils.property_from_stylesheet (   propname,
  style,
  default = None 
)

◆ property_to_stylesheet()

def pycross.utils.utils.property_to_stylesheet (   propname,
  propvalue,
  style 
)

◆ register_file_types()

def pycross.utils.utils.register_file_types (   filetypes = ('xpf', 'ipuz', 'pxjson'),
  register = True 
)

◆ restart_app()

def pycross.utils.utils.restart_app (   closefunction)

◆ run_exe()

def pycross.utils.utils.run_exe (   args,
  external = False,
  capture_output = True,
  stdout = subprocess.PIPE,
  encoding = ENCODING,
  timeout = None,
  shell = False,
**  kwargs 
)

◆ str_to_datetime()

def pycross.utils.utils.str_to_datetime (   text,
  strformat = '%Y-%m-%d %H-%M-%S' 
)

◆ str_to_timestamp()

def pycross.utils.utils.str_to_timestamp (   text,
  strformat = '%Y-%m-%d %H-%M-%S' 
)

◆ stylesheet_dump()

def pycross.utils.utils.stylesheet_dump (   d,
  quoted_keys = ('font-family',),
  add_units = {'font-size': 'pt', 'border': 'px', 'border-width': 'px'} 
)

◆ stylesheet_load()

def pycross.utils.utils.stylesheet_load (   style,
  dequote = True,
  strip_sz = True,
  units = ('pt', 'px') 
)

◆ timestamp_to_str()

def pycross.utils.utils.timestamp_to_str (   ts = None,
  strformat = '%Y-%m-%d %H-%M-%S' 
)

◆ UserInput()

def pycross.utils.utils.UserInput (   dialogtype = 'text',
  parent = None,
  title = 'pyCross',
  label = '',
  value = None,
  textmode = 'normal',
  valrange = None,
  decimals = 1,
  step = 1,
  comboeditable = True,
  comboitems = [] 
)

◆ walk_dir()

def pycross.utils.utils.walk_dir (   root_path,
  abs_path = True,
  recurse = True,
  dir_process_function = None,
  file_process_function = None,
  file_types = None 
)
 

Variable Documentation

◆ MSGBOX_BUTTONS

dictionary pycross.utils.utils.MSGBOX_BUTTONS
Initial value:
1 = {'ok': (_('OK'), QtWidgets.QMessageBox.AcceptRole), 'yes': (_('Yes'), QtWidgets.QMessageBox.YesRole),
2  'no': (_('No'), QtWidgets.QMessageBox.NoRole), 'cancel': (_('Cancel'), QtWidgets.QMessageBox.RejectRole),
3  'yesall': (_('Yes to All'), QtWidgets.QMessageBox.YesRole), 'noall': (_('No to All'), QtWidgets.QMessageBox.NoRole),
4  'apply': (_('Apply'), QtWidgets.QMessageBox.ApplyRole), 'reset': (_('Reset'), QtWidgets.QMessageBox.ResetRole),
5  'open': (_('Open'), QtWidgets.QMessageBox.AcceptRole), 'save': (_('Save'), QtWidgets.QMessageBox.AcceptRole),
6  'close': (_('Close'), QtWidgets.QMessageBox.RejectRole), 'discard': (_('Discard'), QtWidgets.QMessageBox.DestructiveRole),
7  'restoredefaults': (_('Restore Defaults'), QtWidgets.QMessageBox.ResetRole), 'help': (_('Help'), QtWidgets.QMessageBox.HelpRole),
8  'saveall': (_('Save All'), QtWidgets.QMessageBox.AcceptRole), 'abort': (_('Abort'), QtWidgets.QMessageBox.RejectRole),
9  'retry': (_('Retry'), QtWidgets.QMessageBox.AcceptRole), 'ignore': (_('Ignore'), QtWidgets.QMessageBox.AcceptRole)}

◆ MSGBOX_TYPES

dictionary pycross.utils.utils.MSGBOX_TYPES
Initial value:
1 = {'error': (QtWidgets.QMessageBox.Critical, ['ok']), 'warn': (QtWidgets.QMessageBox.Warning, ['ok']), 'ask': (QtWidgets.QMessageBox.Question, ['yes', 'no']),
2  'info': (QtWidgets.QMessageBox.Information, ['ok']), '-': (QtWidgets.QMessageBox.NoIcon, ['ok'])}