pycrossword  0.2
Pure-Python implementation of a crossword puzzle generator and editor
Public Member Functions | Public Attributes | Private Member Functions | List of all members
pycross.utils.update.Updater Class Reference

Public Member Functions

def __init__ (self, app_name, app_version, git_repo, update_file, log_file, check_every=1, check_major_versions=True, git_exe=None, on_get_recent=None, on_before_update=None, on_norecent=None, print_to=sys.stdout)
 
def update (self, force=False)
 
def check_update (self, force=False)
 
def get_recent_version (self)
 

Public Attributes

 app_name
 
 app_version
 
 git_repo
 
 update_file
 
 log_file
 
 print_to
 
 check_every
 
 check_major_versions
 
 on_get_recent
 
 on_before_update
 
 on_norecent
 
 update_info
 
 git_exe
 
 git_installed
 
 pkg_installed
 

Private Member Functions

def _update_check_required (self)
 
def _git_check_installed (self)
 
def _git_check_repo (self)
 
def _git_run (self, *args, **kwargs)
 
def _git_update_from_branch (self, branch_or_commit)
 
def _git_get_remote_branches (self, exclude_starting_with=('master',), include_starting_with=('release',))
 
def _git_get_recent_version (self)
 
def _pip_run (self, *args, **kwargs)
 
def _pip_list_packages (self, outdated_only=False)
 
def _pip_check_pkg_installed (self)
 
def _pip_update (self)
 
def _pip_get_recent_version (self)
 
def _run_exe (self, args, external=False, capture_output=True, stdout=subprocess.PIPE, encoding=ENCODING, timeout=None, shell=False, **kwargs)
 
def _datetime_to_str (self, dt=None, strformat='%Y-%m-%d %H-%M-%S')
 
def _str_to_datetime (self, text, strformat='%Y-%m-%d %H-%M-%S')
 
def _init_update_info (self)
 
def _write_update_info (self)
 
def _strip_version_az (self, version_str)
 
def _parse_version (self, version_str, max_versions=-1)
 
def _compare_versions (self, v1, v2, max_versions=-1, major_only=False)
 

Constructor & Destructor Documentation

◆ __init__()

def pycross.utils.update.Updater.__init__ (   self,
  app_name,
  app_version,
  git_repo,
  update_file,
  log_file,
  check_every = 1,
  check_major_versions = True,
  git_exe = None,
  on_get_recent = None,
  on_before_update = None,
  on_norecent = None,
  print_to = sys.stdout 
)

Member Function Documentation

◆ _compare_versions()

def pycross.utils.update.Updater._compare_versions (   self,
  v1,
  v2,
  max_versions = -1,
  major_only = False 
)
private

◆ _datetime_to_str()

def pycross.utils.update.Updater._datetime_to_str (   self,
  dt = None,
  strformat = '%Y-%m-%d %H-%M-%S' 
)
private

◆ _git_check_installed()

def pycross.utils.update.Updater._git_check_installed (   self)
private

◆ _git_check_repo()

def pycross.utils.update.Updater._git_check_repo (   self)
private

◆ _git_get_recent_version()

def pycross.utils.update.Updater._git_get_recent_version (   self)
private

◆ _git_get_remote_branches()

def pycross.utils.update.Updater._git_get_remote_branches (   self,
  exclude_starting_with = ('master',),
  include_starting_with = ('release',) 
)
private

◆ _git_run()

def pycross.utils.update.Updater._git_run (   self,
args,
**  kwargs 
)
private

◆ _git_update_from_branch()

def pycross.utils.update.Updater._git_update_from_branch (   self,
  branch_or_commit 
)
private

◆ _init_update_info()

def pycross.utils.update.Updater._init_update_info (   self)
private

◆ _parse_version()

def pycross.utils.update.Updater._parse_version (   self,
  version_str,
  max_versions = -1 
)
private

◆ _pip_check_pkg_installed()

def pycross.utils.update.Updater._pip_check_pkg_installed (   self)
private

◆ _pip_get_recent_version()

def pycross.utils.update.Updater._pip_get_recent_version (   self)
private

◆ _pip_list_packages()

def pycross.utils.update.Updater._pip_list_packages (   self,
  outdated_only = False 
)
private

◆ _pip_run()

def pycross.utils.update.Updater._pip_run (   self,
args,
**  kwargs 
)
private

◆ _pip_update()

def pycross.utils.update.Updater._pip_update (   self)
private

◆ _run_exe()

def pycross.utils.update.Updater._run_exe (   self,
  args,
  external = False,
  capture_output = True,
  stdout = subprocess.PIPE,
  encoding = ENCODING,
  timeout = None,
  shell = False,
**  kwargs 
)
private

◆ _str_to_datetime()

def pycross.utils.update.Updater._str_to_datetime (   self,
  text,
  strformat = '%Y-%m-%d %H-%M-%S' 
)
private

◆ _strip_version_az()

def pycross.utils.update.Updater._strip_version_az (   self,
  version_str 
)
private

◆ _update_check_required()

def pycross.utils.update.Updater._update_check_required (   self)
private

◆ _write_update_info()

def pycross.utils.update.Updater._write_update_info (   self)
private

◆ check_update()

def pycross.utils.update.Updater.check_update (   self,
  force = False 
)

◆ get_recent_version()

def pycross.utils.update.Updater.get_recent_version (   self)

◆ update()

def pycross.utils.update.Updater.update (   self,
  force = False 
)

Member Data Documentation

◆ app_name

pycross.utils.update.Updater.app_name

◆ app_version

pycross.utils.update.Updater.app_version

◆ check_every

pycross.utils.update.Updater.check_every

◆ check_major_versions

pycross.utils.update.Updater.check_major_versions

◆ git_exe

pycross.utils.update.Updater.git_exe

◆ git_installed

pycross.utils.update.Updater.git_installed

◆ git_repo

pycross.utils.update.Updater.git_repo

◆ log_file

pycross.utils.update.Updater.log_file

◆ on_before_update

pycross.utils.update.Updater.on_before_update

◆ on_get_recent

pycross.utils.update.Updater.on_get_recent

◆ on_norecent

pycross.utils.update.Updater.on_norecent

◆ pkg_installed

pycross.utils.update.Updater.pkg_installed

◆ print_to

pycross.utils.update.Updater.print_to

◆ update_file

pycross.utils.update.Updater.update_file

◆ update_info

pycross.utils.update.Updater.update_info

The documentation for this class was generated from the following file: