# WAPT Setuphelpers Usage

class setuphelpers.EnsureWUAUServRunning

  Bases: `object`

  Contextual object to ensure that wauserv service is running (in manual mode) Restores previous state at context exit.

class setuphelpers.InstallerTypes

  Bases: `object`

  APPX = 'WExtract'
  ExeWinUpdates = 'ExeWindowsUpdate'
  GenericInstaller = 'GenericInstaller'
  InnoSetup = 'InnoSetup'
  InstallShield = 'InstallShield'
  MSI = 'MSI'
  MSU = 'MSU'
  MozillaInstaller = 'MozillaInstaller'
  NSIS = 'NSIS'
  SFXCab = 'SFXCab'
  SevenZIPSFX = 'SevenZIPSFX'
  UnknownExeInstaller = 'UnknownExeInstaller'
  UnknownInstaller = 'UnknownInstaller'
  WExtract = 'WExtract'

class setuphelpers.RunOutput(value)

  Bases: `str`

  Subclass of str (bytes) to return returncode from runned command in addition to output

      >>> run(r'cmd /C dir c:     oto ',accept_returncodes=[0,1])
      No handlers could be found for logger "root"
      <RunOuput returncode :[0, 1]>
       Le volume dans le lecteur C n'a pas de nom.
       Le numéro de série du volume est 74EF-5918

  Fichier introuvable

    Répertoire de c:

  Changed in version 1.4.0: subclass str(bytes string) and not unicode

class setuphelpers.RunReader(callable, *args, **kwargs)

  Bases: `Thread`

  run()

exception setuphelpers.TimeoutExpired(cmd, output=None, timeout=None)

  Bases: `Exception`

  This exception is raised when the timeout expires while waiting for a child process.

      >>> try:
      ...     run('ping -t 10.10.1.67',timeout=5)
      ... except TimeoutExpired as e:
      ...     print e.output
      ...     raise
      ...

class setuphelpers.WindowsVersions

  Bases: `object`

  Helper class to get numbered windows version from windows name version

  Sources: https://msdn.microsoft.com/en-us/library/windows/desktop/dn481241(v=vs.85).aspx https://msdn.microsoft.com/en-us/library/windows/desktop/ms724832(v=vs.85).aspx https://en.wikipedia.org/wiki/List_of_Microsoft_Windows_versions

  … versionadded:: 1.3.5

  Changed in version 1.9: Adding Windows 10.0 and newer versions

  Changed in version 2.0: Adding Windows 10 version 20H1 and newer versions

  Changed in version 2.2: Adding Windows 11/2023 versions

  Windows10 = Version('10.0')
  Windows10v1507 = Version('10.0.10240')
  Windows10v1511 = Version('10.0.10586')
  Windows10v1607 = Version('10.0.14393')
  Windows10v1703 = Version('10.0.15063')
  Windows10v1709 = Version('10.0.16299')
  Windows10v1803 = Version('10.0.17134')
  Windows10v1809 = Version('10.0.17763')
  Windows10v1903 = Version('10.0.18362')
  Windows10v1909 = Version('10.0.18363')
  Windows10v2004 = Version('10.0.19041')
  Windows10v2009 = Version('10.0.19042')
  Windows10v20H1 = Version('10.0.19041')
  Windows10v20H2 = Version('10.0.19042')
  Windows10v21H1 = Version('10.0.19043')
  Windows10v21H2 = Version('10.0.19044')
  Windows10v22H2 = Version('10.0.19045')
  Windows11 = Version('10.0.22000')
  Windows11v22H2 = Version('10.0.22621')
  Windows11v23H2 = Version('10.0.22631')
  Windows11v24H2 = Version('10.0.26100')
  Windows11v25H2 = Version('10.0.26200')
  Windows2000 = Version('5.0')
  Windows7 = Version('6.1')
  Windows7SP1 = Version('6.1.7601')
  Windows8 = Version('6.2')
  Windows81 = Version('6.3')
  WindowsServer2003 = Version('5.2')
  WindowsServer2003R2 = Version('5.2')
  WindowsServer2008 = Version('6.0')
  WindowsServer2008R2 = Version('6.1')
  WindowsServer2012 = Version('6.2')
  WindowsServer2012R2 = Version('6.3')
  WindowsServer2016 = Version('10.0.14393')
  WindowsServer2019 = Version('10.0.17763')
  WindowsServer2022 = Version('10.0.20348')
  WindowsVista = Version('6.0')
  WindowsVistaSP2 = Version('6.0.6002')
  WindowsXP = Version('5.1')
  WindowsXP64 = Version('5.2')

setuphelpers.add_netfirewallrule(rule_name, app_path, group=None, direction='Inbound', profile=None, enabled=True, action='Allow', protocol=None, remote_addresses=None)

  Add a Windows Firewall rule using New-NetFirewallRule cmdlet in PowerShell for Windows 10 and newer, or netsh advfirewall for older Windows versions.

  https://learn.microsoft.com/troubleshoot/windows-server/networking/netsh-advfirewall-firewall-control-firewall-behavior https://learn.microsoft.com/powershell/module/netsecurity/new-netfirewallrule

  Args:

    rule_name (str): Display name for the firewall rule. app_path (str): Path to the program for which the rule is being created. group (str, optional): Group name for the firewall rule (only works with PowerShell). direction (str): Direction of the rule (Inbound or Outbound). Default: Inbound. profile (str or list, optional): Profile(s) to which the rule should apply (e.g., “Domain,Private”). Default: Any. enabled (bool): Specify if the created rule’s state is Enabled (True) or not (False). Default: True. action (str): Action for the rule (Allow or Block). Default: Allow. protocol (str, optional): Protocol by name or number (e.g., “TCP”, “UDP”, “ICMPv4”, or “ICMPv6”). Default: Any. remote_addresses (str or list, optional): Specifies that network packets with matching IP addresses match this rule. Default: None.

  Returns:

    waptutils.RunOutput: The result of the command execution.

  New in version 2.5.

setuphelpers.add_shutdown_script(cmd, parameters)

  Adds a local shutdown script as a local GPO

  Args:

    cmd (str): absolute path to exe or bat file (without parameters) parameters (str): parameters to append to command

  Returns:

    int: index of command into the list of shutdown scripts

      >>> index = add_shutdown_script(r'c:\wapt\wapt-get.exe','update')

setuphelpers.add_to_system_path(path)

  Add path to the global search PATH environment variable if it is not yet

setuphelpers.add_user_to_group(user, group)

  Add membership to a local group for a user

setuphelpers.adjust_current_privileges(priv, enable=1)

setuphelpers.all_files(rootdir: str, pattern: Optional[str] = None) → List[str]

  Recursively return all files from rootdir and sub directories matching the (dos style) pattern (example: *.exe)

setuphelpers.application_data(common=0)

  What folder holds application configuration files?

setuphelpers.battery_lifetime()

  Return battery life in seconds

  New in version 1.4.2.

setuphelpers.battery_percent()

  Return battery level in percent

  New in version 1.4.2.

setuphelpers.bookmarks(common=0)

  What folder holds the Explorer favourites shortcuts?

setuphelpers.common_desktop()

  Return path to public desktop (visible by all users)

      >>> common_desktop()
      u'C:\\Users\\Public\\Desktop'

setuphelpers.copytree2(src: str, dst: str, ignore: ~typing.Optional[~typing.Callable[[str, str], ~typing.List[str]]] = None, onreplace: ~typing.Callable[[str, str], bool] = <function default_skip>, oncopy: ~typing.Callable[[str, str, str], bool] = <function default_oncopy>, enable_replace_at_reboot: bool = True, follow_symlinks: bool = False)

  Copy src directory to dst directory. dst is created if it doesn’t exists src can be relative to installation temporary dir

  oncopy is called for each file copy. if False is returned, copy is skipped onreplace is called when a file will be overwritten.

  Args:

    src (str): path to source directory (absolute path or relative to package extraction tempdir) dst (str): path to target directory (created if not present) ignore (func) : callback func(root_dir,filenames) which returns names to ignore onreplace (func) : callback func(src,dst):boolean called when a file will be replaced to decide what to do.

    > default is to not replace if target exists. can be default_overwrite or default_overwrite_older or custom function.

    oncopy (func)callback func(msg,src,dst) called when a file is copied.

      default is to log in debug level the operation

    enable_replace_at_reboot (boolean): if True, files which are locked will be scheduled for replace at next reboot

  Returns:

  Raises:

      >>> copytree2(r'c:\tranquilit\wapt\tests',r'c:\tranquilit\wapt\tests2')
      >>> isdir(r'c:\tranquilit\wapt\tests2')
      True
      >>> remove_tree(r'c:\tranquilit\wapt\tests2')
      >>> isdir(r'c:\tranquilit\wapt\tests2')
      False

setuphelpers.create_daily_task(name, cmd, parameters, max_runtime=10, repeat_minutes=None, start_hour=None, start_minute=None)

  creates a Windows scheduled daily task and activate it.

  Args:

    name (str): name of task for reference cmd(str) : command line parameters (str) : arguments to append to cmd max_runtime (int): maximum running time in minutes repeat_minutes (int): interval in minutes between run start_hour (int): hour time of start start_minute (int): minute time of start

  Returns:

    PyITask: scheduled task

setuphelpers.create_desktop_shortcut(label, target='', arguments='', wDir='', icon='')

  Create a desktop shortcut link for all users

  Args:

    label (str): Name of the shorcut (.lnk extension is appended if not provided) target (str) : path to application arguments (str): argument to pass to application wDir (str): working directory icon (str): path to ico file

  Returns:

    str: Path to the shortcut

      >>> create_desktop_shortcut(r'WAPT Console Management',target=r'c:\wapt\waptconsole.exe')
      u'C:\\Users\\Public\\Desktop\\WAPT Console Management.lnk'
      >>> create_desktop_shortcut(r'WAPT local status',target='http://localhost:8088/')
      u'C:\\Users\\Public\\Desktop\\WAPT local status.url'

setuphelpers.create_group(group)

  Creates a local group

setuphelpers.create_onetime_task(name, cmd, parameters=None, delay_minutes=2, max_runtime=10, retry_count=3, retry_delay_minutes=1)

  creates a one time Windows scheduled task and activate it.

setuphelpers.create_programs_menu_shortcut(label, target='', arguments='', wDir='', icon='', folder=None)

  Create a program menu shortcut link for all users

  if label’s extension is url, a http shortcut is created, else creates a file system shortcut.

  Args:

    label : Name of the shorcut (.lnk extension is appended if not provided.) target : path to application arguments : argument to pass to application wDir : working directory icon : path to ico file folder (str) : folder of Programs Menu where to put the shortcut.

  Returns:

    str: Path to the shortcut

      >>> create_programs_menu_shortcut('Dev-TranquilIT', target='http://dev.tranquil.it')
      u'C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Dev-TranquilIT.url'
      >>> create_programs_menu_shortcut('Console WAPT', target=makepath('c:/wapt','waptconsole.exe'))
      u'C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Console WAPT.lnk'

setuphelpers.create_shortcut(path, target='', arguments='', wDir='', icon='')

  Create a windows shortcut

  Args:

    path (str) : As what file should the shortcut be created? target (str): What command should the desktop use? arguments (str): What arguments should be supplied to the command? wdir (str) : working directory. What folder should the command start in? icon (str or list) : filename or (filename, index) (only for file sc)

    > What icon should be used for the shortcut

  Returns:

    None

      >>> create_shortcut(r'c:\\tmp\\test.lnk',target='c:\\wapt\\waptconsole.exe')

setuphelpers.create_user(user, password, full_name=None, comment=None)

  Creates a local user

setuphelpers.create_user_desktop_shortcut(label, target='', arguments='', wDir='', icon='')

  Create a desktop shortcut link for current user

  Args:

    label (str): Name of the shorcut (.lnk extension is appended if not provided) target (str) : path to application arguments (str): argument to pass to application wDir (str): working directory icon (str): path to ico file

  Returns:

    str: Path to the shortcut

      >>> create_user_desktop_shortcut(r'WAPT Console Management',target='c:\\wapt\\waptconsole.exe')
      u'C:\\Users\\htouvet\\Desktop\\WAPT Console Management.lnk'
      >>> create_user_desktop_shortcut(r'WAPT local status',target='http://localhost:8088/')
      u'C:\\Users\\htouvet\\Desktop\\WAPT local status.url'

setuphelpers.create_user_programs_menu_shortcut(label, target='', arguments='', wDir='', icon='', folder=None)

  Create a shortcut in the start menu of the current user

  > If label extension is url, create a Http shortcut, else a file system shortcut.

  Args:

    label : Name of the shorcut (.lnk or .url extension is appended if not provided.) target : path to application arguments : argument to pass to application wDir : working directory icon : path to ico file folder (str) : folder of User’s Programs Menu where to put the shortcut.

  Returns:

    str: Path to the shortcut

      >>> create_user_programs_menu_shortcut('Doc-TranquilIT', target='https://doc.wapt.fr')
      u'C:\\Users\\htouvet\\AppData\\Roaming\\Microsoft\\Windows\\Start Menu\\Programs\\Doc-TranquilIT.url'
      >>> create_user_programs_menu_shortcut('Console WAPT', target=makepath('c:/wapt','waptconsole.exe'))
      u'C:\\Users\\htouvet\\AppData\\Roaming\\Microsoft\\Windows\\Start Menu\\Programs\\Console WAPT.lnk'

setuphelpers.critical_system_pending_updates(severities=['Critical'])

  Return list of not installed critical updates

  Returns:

    list: list of title of WSUS crititcal updates not applied

setuphelpers.currentdate()

  date as string YYYYMMDD

      >>> currentdate()
      '20161102'

setuphelpers.currentdatetime()

  date/time as YYYYMMDD-hhmmss

      >>> currentdatetime()
      '20161102-193600'

setuphelpers.dateof(adatetime: datetime) → datetime

setuphelpers.datetime2isodate(adatetime: Optional[datetime] = None) → str

  Return an iso8601 representation of the date/time If adatetime is None, return current datetime in UTC

setuphelpers.default_gateway()

  Returns default ipv4 current gateway

setuphelpers.default_oncopy(msg, src, dst)

setuphelpers.default_overwrite(src, dst)

setuphelpers.default_overwrite_older(src: str, dst: str)

setuphelpers.default_skip(src, dst)

setuphelpers.default_user_appdata()

  Return the roaming appdata profile of default user

  Returns:

    str: path like u’C:\Users\Default\AppData\Roaming’

setuphelpers.default_user_local_appdata()

  Return the local appdata profile of current user

  Returns:

    str: path like u’C:\Users\Default\AppData\Local’

setuphelpers.delete_at_next_reboot(target_filename)

  delete at next reboot using standard Windows PendingFileRenameOperations Creates a key in HKEY_LOCAL_MACHINESystemCurrentControlSetControlSession Manager with content :

  > PendingFileRenameOperations

  >   Data type : REG_MULTI_SZ Value data: [??path,0]

  Args:

    target_filename (str): File to delete

setuphelpers.delete_group(group)

  Delete a local user group

setuphelpers.delete_task(name)

  Removes a Windows scheduled task

  Args:

    name (str) : name of the tasks as created in create_daily_task

setuphelpers.delete_user(user)

  Delete a local user

setuphelpers.desktop(common=0)

  What folder is equivalent to the current desktop?

setuphelpers.detect_file_encoding(file_path)

  Detect the encoding of a file.

  Args:

    file_path (str): The path to the file to be analyzed.

  Returns:

    str: The detected character encoding of the file.

      >>> detect_file_encoding(file_path)
      'UTF-8-SIG'

setuphelpers.dir_is_empty(path: str) → bool

  Check if a directory is empty

class setuphelpers.disable_file_system_redirection

  Bases: `object`

  Context manager to disable temporarily the wow3264 file redirector

      >>> with disable_file_system_redirection():
      ...     winshell.get_path(shellcon.CSIDL_PROGRAM_FILES)
      u'C:\\Program Files (x86)'

setuphelpers.disable_task(name)

  Disable a Windows scheduled task

setuphelpers.dmi_info()

  Hardware System information from BIOS extracted with dmidecode Convert dmidecode -q output to python dict

  Returns:

    dict

      >>> dmi = dmi_info()
      >>> 'UUID' in dmi['System_Information']
      True
      >>> 'Product_Name' in dmi['System_Information']
      True

setuphelpers.enable_task(name)

  Enable (start of) a Windows scheduled task

  Args:

    name (str) : name of the tasks as created in create_daily_task

setuphelpers.ensure_dir(filename: str)

  Be sure the directory of filename exists on disk. Create it if not

  The intermediate directories are created either.

  Args:

    filename (str): path to a future file for which to create directory.

  Returns:

    None

setuphelpers.ensure_list(csv_or_list: Union[List[str], str], ignore_empty_args=True, allow_none=False) → List

  if argument is not a list, return a list from a csv string

  Args:

    csv_or_list (list or str): ignore_empty_args (bool): if True, empty string found in csv are not appended to the list. allow_none (bool): if True, if csv_or_list is None, return None, else return empty list/

  Returns:

    list

setuphelpers.ensure_unicode(data)

  Return a unicode string from data object It is sometimes difficult to know in advance what we will get from command line application output.

  This is to ensure we get a (not always accurate) representation of the data mainly for logging purpose.

  Args:

    data: either str or unicode or object having a __str__ or WindowsError or Exception

  Returns:

    unicode: unicode string representing the data

      >>> ensure_unicode(str('éé'))
      u'éé'
      >>> ensure_unicode(u'éé')
      u'éé'
      >>> ensure_unicode(Exception("test"))
      u'Exception: test'
      >>> ensure_unicode(Exception())
      u'Exception: '

setuphelpers.error(reason: str)

  Raise a WAPT fatal error

setuphelpers.file_is_locked(path: str, timeout: int = 5) → bool

  Check if a file is locked. waits timout seconds for the release

setuphelpers.filecopyto(filename: str, target: str)

  Copy file from absolute or package temporary directory to target directory

  If file is dll or exe, logs the original and new version.

  Args:
    filename (str): absolute path to file to copy,

      or relative path to temporary package install content directory.

    target (str) : absolute path to target directory where to copy file.

    target is either a full filename or a directory name if filename is .exe or .dll, logger prints version numbers

      >>> if not os.path.isfile('c:/tmp/fc.test'):
      ...     with open('c:/tmp/fc.test','wb') as f:
      ...         f.write('test')
      >>> if not os.path.isdir('c:/tmp/target'):
      ...    os.mkdir('c:/tmp/target')
      >>> if os.path.isfile('c:/tmp/target/fc.test'):
      ...    os.unlink('c:/tmp/target/fc.test')
      >>> filecopyto('c:/tmp/fc.test','c:/tmp/target')
      >>> os.path.isfile('c:/tmp/target/fc.test')
      True

setuphelpers.fileisodate(filename: str) → str

  Returns last update date time from filename in local time

setuphelpers.find_all_files(rootdir: str, include_patterns: Optional[Union[str, List[str]]] = None, exclude_patterns: Optional[Union[str, List[str]]] = None, include_dirs: Optional[Union[str, List[str]]] = None, exclude_dirs: Optional[Union[str, List[str]]] = None, excludes_full: Optional[List[str]] = None)

  Generator which recursively find all files from rootdir and sub directories matching the (dos style) patterns (example: *.exe)

  Args;

    rootdir (str): root dir where to start looking for files include_patterns (str or list) : list of glob pattern of files to return exclude_patterns (str or list) : list of glob pattern of files to exclude

    > (if a file is both in include and exclude, it is excluded)

    include_dirs (str or list) : list of glob directory patterns to return exclude_dirs (str or list) : list of glob directory patterns to exclude

    > (if a dir is both in include and exclude, it is excluded)

    excludes_full (list) : list of exact (relative to package root) filepathes to exclude from manifest.

      >>> for fn in find_all_files('c:\tmp','*.txt'):
              print(fn)
      >>>

setuphelpers.find_processes(process_name)

  Return list of Process names process_name

  Args:

    process_name (str): process name to lookup

  Returns:

    list: list of processes (Process) named process_name or process_name.exe

      >>> [p.pid for p in find_processes('explorer')]
      [2756, 4024]

setuphelpers.fix_wmi()

  reregister all the WMI related DLLs in the wbem folder

setuphelpers.get_all_scheduled_tasks(enable_only=False)

setuphelpers.get_antivirus_info()

setuphelpers.get_app_install_location(uninstallkey)

  Get the registered application install location from registry given its uninstallkey

      >>> get_app_install_location('wapt_is1')
      u'C:\\wapt\\'

setuphelpers.get_app_path(exename)

  Get the registered application location from registry given its executable name

      >>> get_app_path('firefox.exe')
      u'C:\\Program Files (x86)\\Mozilla Firefox\\firefox.exe'
      >>> get_app_path('wapt-get.exe')
      u'C:\\wapt\\wapt-get.exe'

setuphelpers.get_appath(exename)

  Get the registered application location from registry given its executable name

      >>> get_app_path('firefox.exe')
      u'C:\\Program Files (x86)\\Mozilla Firefox\\firefox.exe'
      >>> get_app_path('wapt-get.exe')
      u'C:\\wapt\\wapt-get.exe'

setuphelpers.get_battery_infos(idx: int) → dict

  Informations on battery. Args:

  > idx (int): battery index

  Returns:

    dict

setuphelpers.get_computer_description()

  Get the computer descrption

setuphelpers.get_computer_domain()

  Get computer AD domain

setuphelpers.get_computer_groups(nested_groups=True)

setuphelpers.get_computer_groups_from_gpo()

setuphelpers.get_computername()

  Return host name (without domain part)

setuphelpers.get_current_user()

  Get the login name for the current user.

      >>> get_current_user()
      u'htouvet'

setuphelpers.get_default_app(suffix)

  Return application path associated to a file extension (example: .pptx)

      >>> get_default_app('.pptx')
      'C:\\Program Files\\LibreOffice\\program\\simpress.exe'

setuphelpers.get_default_gateways()

setuphelpers.get_disk_free_space(filepath: str) → int

  Returns the number of free bytes on the drive that filepath is on

setuphelpers.get_dns_servers()

setuphelpers.get_domain_fromregistry()

  Return main DNS domain of the computer

  Returns:

    str: domain name

      >>> get_domain_fromregistry()
      u'tranquilit.local'

setuphelpers.get_file_association(ext)

  Return the associated application for a file extension (example : ‘.doc’)

      >>> get_file_association('.pptx')
      'LibreOffice.Pptx'

setuphelpers.get_file_properties(fname, ignore_warning=True)

  Read all properties of the given file return them as a dictionary.

  Source: http://stackoverflow.com/questions/580924/python-windows-file-version-attribute

  Args:

    fname : path to Windows executable or DLL

  Returns:

    dict: properties of executable

      >>> xp = get_file_properties(r'c:\windows\explorer.exe')
      >>> 'FileVersion' in xp and 'FileDescription' in xp
      True

setuphelpers.get_fqdn()

setuphelpers.get_host_architecture()

setuphelpers.get_hostname()

  Return host fully qualified domain name in lower case

  If a main domain is set in registry, use this domain (faster) If not, use value returned from main connection (ie DHCP)

  Result is cached because Windows 10 is sometimes slow to return when there are multiple network interfaces.

setuphelpers.get_installer_defaults_win(installer_path)

  Returns guessed default values for package templates based on installer binary

  Args:

    installer_path (str): filepath to installer

  Returns:

    dict:

      >>> get_installer_defaults(r'c:     ranquilit\wapt  ests\SumatraPDF-3.1.1-install.exe')
      {'description': u'SumatraPDF Installer (Krzysztof Kowalczyk)',
       'filename': 'SumatraPDF-3.1.1-install.exe',
       'silentflags': '/VERYSILENT',
       'simplename': u'sumatrapdf-installer',
       'type': 'UnknownExeInstaller',
       'version': u'3.1.1'}

      >>> get_installer_defaults(r'c:     ranquilit\wapt  estsz920.msi')
      {'description': u'7-Zip 9.20 (Igor Pavlov)',
       'filename': '7z920.msi',
       'silentflags': '/q /norestart',
       'simplename': u'7-zip-9.20',
       'type': 'MSI',
       'version': u'9.20.00.0'}

setuphelpers.get_language(full_locale=False, separator='_')

  Get the os default locale (example: fr, en, pl, etc.)

      >>> get_language()
      'fr'
      >>> get_language(full_locale=True)
      'fr_FR'
      >>> get_language(full_locale=True, separator='-').lower()
      'fr-fr'

setuphelpers.get_language_code()

  Return the current Windows language code

  Returns:

    integer

      >>> get_language_code()
      1036

setuphelpers.get_last_logged_on_user()

setuphelpers.get_local_IPs(uponly=True)

setuphelpers.get_local_profiles(domain_sid=None)

  Return list of locally created profiles usernames

setuphelpers.get_loggedinusers()

  Return the list of logged in users on this host

  Returns:

    list: list of users logins

      >>> get_loggedinusers()
      [u'htouvet']

setuphelpers.get_main_ip(host=None, hostv6=None)

setuphelpers.get_msi_properties(msi_filename, list_properties=['FileDescription', 'ProductCode', 'version', 'product', 'publisher', 'description', 'ProductVersion', 'UpgradeCode', 'Manufacturer', 'CompanyName', 'FileVersion', 'product', 'ProductName'])

  Return a dict of msi installer properties

  Source: http://stackoverflow.com/questions/3157955/get-msi-product-name-version-from-command-line

  Args:

    msi_filename (str): path to msi file

  Returns:
    dict: properties of msi. at least there seems to be keys like

      ‘Manufacturer’,’ProductCode’,’ProductName’,’ProductVersion’

      >>> zprop = get_msi_properties(r'C:\tranquilit\wapt\tests\7z920.msi')
      >>> 'ProductVersion' in zprop and 'ProductCode' in zprop and 'ProductName' in zprop
      True

setuphelpers.get_os_name()

  Get the name of the current running operating system

  Returns:

    str: Windows, Linux, Darwin

      >>> get_os_name()
      'Windows'

setuphelpers.get_os_version()

setuphelpers.get_powershell_str(powershell_cmd: str, value: Optional[str] = None) → str

  Get a value as string from the output of a powershell command WARNING: Adding -AllUsers parameter may be necessary to make sure WAPT is enable to get the request value

  Args:

    powershell_cmd (str): Powershell command value (str) : Value to get as string

  New in version 2.2.

setuphelpers.get_product_props(installer_path)

  get the properties (product, version, description…) of an exe file or a msi file

  Args:

    installer_path (str): filepath to exe or msi file

  Returns:

    dict: {‘product’,’description’,’version’,’publisher’}

setuphelpers.get_profile_path(sid)

  Return the filesystem path to profile of user with SID sid

setuphelpers.get_profiles_users(domain_sid=None)

  Return list of locally created profiles usernames

setuphelpers.get_proxies()

  Return system proxy with the urllib python library

      >>> get_proxies()
      {'http': 'http://srvproxy.ad.domain.lan:8080',
      'https': 'http://srvproxy.ad.domain.lan:8080'}

setuphelpers.get_service_start_mode(service_name)

  Getting actual start mode of a service Returned values: ‘Auto’, ‘Manual’, ‘Disabled’

setuphelpers.get_sha256(afile: str = '', BLOCK_SIZE: int = 1048576) → str

setuphelpers.get_shortcut_properties(shortcut_filename)

  Return a dict of shortcut properties

  Args:

    shortcut_filename (str): path to shortcut

  Returns:
    dict: properties of shortcut

      ‘description’,’hotkey’,’icon_location’,’lnk_filepath’,’show_cmd’,’show_cmd’,’show_states’,’working_directory’

      >>> lnk = get_shortcut_properties(shortcut_filename)
      >>> 'path' in lnk and 'description' in lnk
      True

setuphelpers.get_task(name)

  Return an instance of PyITask given its name (without .job)

setuphelpers.get_user_from_sid(sid, controller=None, fallback_profpath=True)

setuphelpers.get_version_from_binary(filename, property_name='ProductVersion')

  Get installer version from file informations, for now, only exe and msi files are compatibles

  Args:

    filename (str): path to the file property_name (str): selected property

  Returns:

    str: version number

setuphelpers.getscreens()

setuphelpers.getsilentflags(installer_path)

  Detect the type of installer and returns silent silent install flags

  Args:

    installer_path (str): filepath to installer

  Returns:

    str: detected command line flags to append to installer

      >>> getsilentflags(r'C:     ranquilit\wapt  estsz920.msi')
      '/q /norestart'

setuphelpers.host_info()

  Read main workstation informations, returned as a dict

  Returns:

    dict: main properties of host, networking and windows system

  Changed in version 1.4.1: returned keys changed : dns_domain -> dnsdomain

      >>> hi = host_info()
      >>> 'computer_fqdn' in hi and 'connected_ips' in hi and 'computer_name' in hi and 'mac' in hi
      True

setuphelpers.host_info_networking()

setuphelpers.host_metrics()

  Frequently updated host data

setuphelpers.hours_minutes(hours: Optional[float]) → Optional[str]

setuphelpers.httpdatetime2isodate(httpdate: str, localtime: bool = False) → str

  Convert a date string as returned in http headers or mail headers to isodate (UTC)

      >>> import requests
      >>> last_modified = requests.head('http://wapt/wapt/Packages',headers={'cache-control':'no-cache','pragma':'no-cache'}).headers['last-modified']
      >>> len(httpdatetime2isodate(last_modified)) == 19
      True

setuphelpers.inifile_deleteoption(inifilename: str, section: str, key: str)

  Remove a key within the section of the inifile

  Args:

    inifilename (str): Path to the ini file section (str): section key (str): value key of option to remove

  Returns:

    boolean : True if the key/option has been removed

      >>> inifile_writestring('c:/tranquilit/wapt/tests/test.ini','global','version','1.1.2')
      >>> print inifile_hasoption('c:/tranquilit/wapt/tests/test.ini','global','version')
      True
      >>> print inifile_deleteoption('c:/tranquilit/wapt/tests/test.ini','global','version')
      False

setuphelpers.inifile_deletesection(inifilename: str, section: str)

  Remove a section within the inifile

  Args:

    inifilename (str): Path to the ini file section (str): section to remove

  Returns:

    boolean : True if the section has been removed

setuphelpers.inifile_hasoption(inifilename: str, section: str, key: str) → bool

  Check if an option is present in section of the inifile

  Args:

    inifilename (str): Path to the ini file section (str): section key (str): value key to check

  Returns:

    boolean : True if the key exists

      >>> inifile_writestring('c:/tranquilit/wapt/tests/test.ini','global','version','1.1.2')
      >>> print inifile_hasoption('c:/tranquilit/wapt/tests/test.ini','global','version')
      True
      >>> print inifile_hasoption('c:/tranquilit/wapt/tests/test.ini','global','dontexist')
      False

setuphelpers.inifile_hassection(inifilename: str, section: str) → bool

  Check if an option is present in section of the inifile

  Args:

    inifilename (str): Path to the ini file section (str): section

  Returns:

    boolean : True if the key exists

      >>> inifile_writestring('c:/tranquilit/wapt/tests/test.ini','global','version','1.1.2')
      >>> print inifile_hassection('c:/tranquilit/wapt/tests/test.ini','global')
      True

setuphelpers.inifile_readstring(inifilename: str, section: str, key: str, default: Optional[str] = None)

  Read a string parameter from inifile

      >>> inifile_writestring('c:/tranquilit/wapt/tests/test.ini','global','version','1.1.2')
      >>> print inifile_readstring('c:/tranquilit/wapt/tests/test.ini','global','version')
      1.1.2
      >>> print inifile_readstring('c:/tranquilit/wapt/tests/test.ini','global','undefaut','defvalue')
      defvalue

setuphelpers.inifile_writestring(inifilename: str, section: str, key: str, value: str)

  Write a string parameter to inifile

      >>> inifile_writestring('c:/tranquilit/wapt/tests/test.ini','global','version','1.1.1')
      >>> print inifile_readstring('c:/tranquilit/wapt/tests/test.ini','global','version')
      1.1.1

setuphelpers.install_exe_if_needed(exe, silentflags=None, key=None, min_version=None, killbefore=[], accept_returncodes=[0, 3010], timeout=600, get_version=None, remove_old_version=False, force=False, uninstallkeylist=None, pidlist=None, keywords=None, name=None, time_wait_uninstallkey_present=300)

  Install silently the supplied setup executable file, and add the uninstall key to global uninstallkey list if it is defined.

  Check if already installed at the supllied min_version.

  Kill the processes in killbefore list before launching the setup.

  Raises an error if, after the setup install, the uninstall key is not found in registry.

  Args:

    exe (str) : path to the setup exe file silentflags (str) : flags to append to the exe command line for silent install

    > if not provided, tries to guess them.

    key (str) : uninstall key to check in registry and to add to uninstallkey global list min_version (str) : if installed version is equal or gretaer than this, don’t install

    > if not provided (None), guess it from exe setup file properties. if == ‘’: ignore version check.

    kill_before (list of str)processes to kill before setup, to avoid file locks

      issues.

    get_version (callable)optional func to get installed software version from one entry retunred by installed_softwares

      if not provided, version is taken from ‘version’ attribute in uninstall registry

    remove_old_version (bool) : If True, uninstall the old version matching the provided key explicitely before installing the new one.

  Returns:

    None

  New in version 1.3.2.

  Changed in version 1.3.10: added get_version callback for non conventional setup.exe

  Changed in version 1.4.1: error code 1603 is no longer accepted by default.

  Changed in version 1.5: added remove_old_version to explicitly remove old version

setuphelpers.install_location(uninstallkey)

  Return the install location of the software given its uninstall key or None if not found

      >>> install_location('winscp3_is1')
      u'C:\Program Files\WinSCP\'

setuphelpers.install_msi_if_needed(msi, min_version=None, killbefore=None, accept_returncodes=[0, 3010], timeout=600, properties=None, get_version=None, remove_old_version=False, force=False, uninstallkeylist=None, pidlist=None, key=None, keywords=None, name=None, time_wait_uninstallkey_present=300)

  Install silently the supplied msi file, and add the uninstall key to uninstallkeylist list

  uninstall key, min_version and silent flags are guessed from msi file.

  Raises an error if, after the msi install, the uninstall key is not found in registry.

  The matching is done on key

  Args:

    msi (str) : path to the MSI file min_version (str) : if installed version is equal or gretaer than this, don’t install

    > if not provided (None), guess it from exe setup file properties. if == ‘’: ignore version check.

    kill_before (list of str)processes to kill before setup, to avoid file locks

      issues.

    accept_returncodes (list of int) : return codes which are acceptable and don’t raise exception timeout int) : maximum run time of command in seconds bfore the child is killed and error is raised. properties (dict) : map (key=value) of properties for specific msi installation. remove_old_version (bool) : If True, uninstall the old version explicitely before installing the new one.

  These 3 args are set automatically when run from install() :

  > force (bool) : Value is set automatically when run from install(). install even if already at the right version uninstallkeylist (list) : if the installation is run, add the msi unsinstall key to this list pidlist (list) : if a process is created, add the pid to this list. (useful for external watchdogs in case of abort)

  Returns:

    None

  New in version 1.3.2.

  Changed in version 1.3.10: added get_version callback for non conventional setup.exe

  Changed in version 1.4.1: error code 1603 is no longer accepted by default.

  Changed in version 1.5: added remove_old_version to explicitly remove old version

setuphelpers.installed_softwares(keywords=None, uninstallkey=None, name=None, ignore_empty_names=True)

  Return list of installed software from registry (both 32bit and 64bit)

  Args:

    keywords (str or list): string to lookup in key, display_name or publisher fields uninstallkey : filter on a specific uninstall key instead of fuzzy search

  Changed in version 1.3.11: name (str regexp) : filter on a regular expression on software name

  Returns:
    list of dicts: [{‘key’, ‘name’, ‘version’, ‘install_date’, ‘install_location’

      ‘uninstall_string’, ‘publisher’,’system_component’}]

      >>> softs = installed_softwares('libre office')
      >>> if softs:
      ...     for soft in softs:
      ...         print uninstall_cmd(soft['key'])
      ???

setuphelpers.installed_softwares_user(keywords=None, uninstallkey=None, name=None, ignore_empty_names=True)

  Return list of installed softwares from current user registry (both 32bit and 64bit)

  Args:

    keywords (str or list): string to lookup in key, display_name or publisher fields uninstallkey : filter on a specific uninstall key instead of fuzzy search

  Changed in version 1.3.11: name (str regexp) : filter on a regular expression on software name

  Returns:
    list of dicts: [{‘key’, ‘name’, ‘version’, ‘install_date’, ‘install_location’

      ‘uninstall_string’, ‘publisher’,’system_component’}]

      >>> softs = installed_softwares_user('libre office')
      >>> if softs:
      ...     for soft in softs:
      ...         print uninstall_cmd(soft['key'])
      ???

setuphelpers.installed_windows_updates(**queryfilter)
  Return list of installed updates, indepently from WUA agent
    Example :

      [… {u’CSName’: u’WSDCARDON’,

      > u’Caption’: u’http://support.microsoft.com/?kbid=3207752’, u’Description’: u’Security Update’, u’FixComments’: u’’, u’HotFixID’: u’KB3207752’, u’InstallDate’: None, u’InstalledBy’: u’TRANQUILITdcardon-adm’, u’InstalledOn’: u’12/28/2016’, u’Name’: None, u’ServicePackInEffect’: u’’, u’Status’: None}

      …]

  Args:

    queryfilter (dict)

  Returns:

    list

  New in version 1.3.3.

setuphelpers.is32()

setuphelpers.is64()

setuphelpers.isARM()

setuphelpers.isARM64()

setuphelpers.is_kb_installed(hotfixid)

  Check whether the Windows KB is installed

  Returns:

    boolean

      >>> is_kb_installed('3216755')
      True
      >>> is_kb_installed('KB3216755')
      True

setuphelpers.is_pending_reboot()

  Check whether operating system is on pending reboot

  Returns:

    boolean

      >>> is_pending_reboot()
      True

setuphelpers.isdir(s)

setuphelpers.isfile(path)

setuphelpers.isodate2datetime(isodatestr: str) → datetime

setuphelpers.isrunning(processname)

  Check if a process is running,

      >>> isrunning('explorer')
      True

setuphelpers.iswin64()

  Check whether operating system is 64bits

  Returns:

    boolean

      >>> iswin64()
      True

setuphelpers.iswinarm()

  Check whether operating system is arm

  Returns:

    boolean

      >>> iswinarm()
      True

setuphelpers.json_load_file(json_file: str, encoding: str = 'utf-8') → Union[list, dict]

  Load content from a JSON file.

  Args:

    json_file: Path to the JSON file. encoding: File encoding.

  Returns:

    Loaded JSON content as a dictionary or a list.

setuphelpers.json_write_file(json_file: str, data: Union[list, dict], indent: int = 4, sort_keys: bool = False, encoding: str = 'utf-8', newline: str = '\n')

  Write dictionary or list to a JSON file.

  Args:

    json_file: Path to the JSON file. data: Dictionary or list content to be written. indent: Tabulation size for indentation. sort_keys: Sort the keys alphabetically or not. encoding: File encoding. newline: Newline character(s) to use, default is Line Feed (LF).

setuphelpers.killalltasks(exenames, include_children=True)

  Kill the task by their exename

      >>> killalltasks('firefox.exe')

setuphelpers.killtree(pid, including_parent=True)

setuphelpers.list_local_printers()

  Return a list of local printers .. versionadded:: 1.7.1

setuphelpers.list_taskbar_pins() → List[Tuple[str, str]]

  Returns a list of the taskbar pinned items. Each element is a 2 strings tuples containing (in order) the display name of the pin and its link path.

setuphelpers.listening_sockets(low_ports=False, include_loc=True, kind='all')

setuphelpers.local_admins()

  List local users who are local administrators

      >>> local_admins()
      [u'Administrateur', u'cyg_user', u'install', u'toto']

setuphelpers.local_desktops()

  Return a list of all local user’s desktops paths

  Args:

    None

  Returns:

    list : list of desktop path

      >>> local_desktops()
      [u'C:\Windows\ServiceProfiles\LocalService\Desktop',
       u'C:\Windows\ServiceProfiles\NetworkService\Desktop',
       u'C:\Users\install\Desktop',
       u'C:\Users\UpdatusUser\Desktop',
       u'C:\Users\administrateur\Desktop',
       u'C:\Users\htouvet-adm\Desktop']

  New in version 1.2.3.

setuphelpers.local_drives()

setuphelpers.local_group_members(groupname)

setuphelpers.local_group_memberships(username)

  List the local groups a user is member Of

setuphelpers.local_groups()

  Returns local groups

      >>> local_groups()
      [u'Administrateurs',
       u'Duplicateurs',
       u'IIS_IUSRS',
       u'Invités',
       u'Lecteurs des journaux d\u2019événements',
       u'Opérateurs de chiffrement',
       u'Opérateurs de configuration réseau',
       u'Opérateurs de sauvegarde',
       u'Utilisateurs',
       u'Utilisateurs avec pouvoir',
       u'Utilisateurs de l\u2019Analyseur de performances',
       u'Utilisateurs du Bureau à distance',
       u'Utilisateurs du journal de performances',
       u'Utilisateurs du modèle COM distribué',
       u'IIS_WPG',
       u'test']

setuphelpers.local_users()

  Returns local users

      >>> local_users()
      [u'Administrateur',
       u'ASPNET',
       u'cyg_user',
       u'install',
       u'Invité',
       u'newadmin',
       u'sshd',
       u'toto',
       u'UpdatusUser']
      >>>

setuphelpers.local_users_profiles()

  Return a list of all local user’s profile paths

  Returns:

    list : list of desktop path

      >>> local_desktops()
      [u'C:\Windows\ServiceProfiles\LocalService',
       u'C:\Windows\ServiceProfiles\NetworkService',
       u'C:\Users\install',
       u'C:\Users\UpdatusUser',
       u'C:\Users\administrateur',
       u'C:\Users\htouvet-adm']

  New in version 1.3.9.

setuphelpers.makepath(*p) → str

  Create a path given the components passed, but with saner defaults than os.path.join - In particular, removes ending path separators (backslashes) from components. Path functions will be called automatically

      >>> makepath("c:", "Windows", "system32")
      'c:\\Windows\\system32'
      >>> makepath(system32())
      'C:\\WINDOWS\\system32'
      >>> system32()
      'C:\\WINDOWS\\system32'
      >>> system32
      <function system32 at 0x063EBE79>
      >>> makepath(system32)
      'C:\\WINDOWS\\system32'

setuphelpers.memory_status()

  Return system memory statistics

setuphelpers.messagebox(title, msg, style=64)

  Open a message box to interact with the end user

  Args:

    title (str): Title of the message box msg (str): Text contained in the message box style (win32con): Format of the message box, usable values:

    > MB_OK MB_OKCANCEL MB_ABORTRETRYIGNORE MB_YESNOCANCEL MB_YESNO MB_RETRYCANCEL

    > MB_ICONHAND MB_ICONQUESTION MB_ICONEXCLAMATION MB_ICONASTERISK MB_ICONWARNING = MB_ICONEXCLAMATION MB_ICONERROR = MB_ICONHAND MB_ICONSTOP = MB_ICONHAND MB_ICONINFORMATION = MB_ICONASTERISK

    > MB_DEFBUTTON1 MB_DEFBUTTON2 MB_DEFBUTTON3 MB_DEFBUTTON4

  Returns:

    ID_OK = 0 ID_CANCEL = 2 ID_ABORT = 3 ID_YES = 6 ID_NO = 7

setuphelpers.mkdirs(path: str)

  Create directory path if it doesn’t exists yet Creates intermediate directories too.

      >>> mkdirs("C:\Program Files (x86)\wapt")
      u'C:\Program Files (x86)\wapt'

setuphelpers.my_documents()

  What folder holds the My Documents files?

setuphelpers.need_install(key=None, min_version=None, force=False, get_version=None, keywords=None, name=None, higher_version_warning=True)

  Return True if the software with key can be found in uninstall registry and the registred version is equal or greater than min_version

  Args:

    key (str): uninstall key min_version (str): minimum version or None if don’t check version (like when key is specific for each soft version) get_version (callable): optional func to get installed software version from one installed_softwares item

    > if not provided, version is taken from ‘version’ attribute in uninstall registry

    keywords (str or list): string to lookup in key, display_name or publisher fields name (str regexp) : filter on a regular expression on software name

  Returns:

    boolean

  Changed in version 2.1: added keywords and name

setuphelpers.networking()

  return a list of (iface,mac,addr:{addr,broadcast,netmask,connected}) without loopback

setuphelpers.pending_reboot_reasons()

  Return the list of reasons requiring a pending reboot the computer If list is empty, no reboot is needed.

  Returns:

    list : list of Windows Update, CBS Updates or File Renames

setuphelpers.pin_to_taskbar(program_path: str) → None

  Pin a program to the taskbar (windows only)

setuphelpers.processes_for_file(filepath, open_files=True, dll=True)

  Generator returning processes currently having a open file descriptor for filepath

  If not running as System account, can not access system processes.

  Args:

    filepath (str): file path or pattern (glob *)

  Returns:

    iterator psutil.Process

setuphelpers.programs(common=0)

  What folder holds the Programs shortcuts(from the Start Menu)?

setuphelpers.reboot_machine(message='Machine Rebooting', timeout=30, force=0, reboot=1)

  Reboot the current host within specified timeout, display a message to the user This can not be cancelled bu the user.

  Args:

    message (str) : displayed to user to warn him timeout (int) : timeout in seconds before proceeding force (int) : If this parameter is 1, applications with unsaved changes

    > > are to be forcibly closed.

    > If this parameter is 0, the system displays a dialog box instructing

    >   the user to close the applications.

    reboot (int) : 1 to reboot after shutdown; If 0, the system halt.

setuphelpers.recent()

  What folder holds the Documents shortcuts(from the Start Menu)?

setuphelpers.reg_closekey(hkey)

  Close a registry key opened with reg_openkey_noredir

setuphelpers.reg_delete_subkeys(rootkey, key_path)

  Delete all subkeys of a key

  rootkey : HKEY_LOCAL_MACHINE, HKEY_CURRENT_USER … key_path : string like “softwaremicrosoftwindowscurrentversion”

setuphelpers.reg_delvalue(key, name)

  Remove the value of specified name inside ‘key’ folder key : handle of registry key as returned by reg_openkey_noredir() name : value name

setuphelpers.reg_enum_subkeys(rootkey)

setuphelpers.reg_enum_values(rootkey)

setuphelpers.reg_getvalue(key, name, default=None, return_as_str=False)

  Return the value of specified name inside ‘key’ folder

      >>> with reg_openkey_noredir(HKEY_LOCAL_MACHINE,'SOFTWARE\\7-Zip') as zkey:
      ...     path = reg_getvalue(zkey,'Path')
      >>> print path
      c:\Program Files\7-Zip\

  Args:

    key : handle of registry key as returned by reg_openkey_noredir() name : value name or None for key default value default : value returned if specified name doesn’t exist

  Returns:

    int or str or list: depends on type of value named name.

setuphelpers.reg_key_exists(rootkey, subkeypath)

  Check if a key exists in registry

  The Wow6432Node redirector is disabled. So one can access 32 and 64 part or the registry even if python is running in 32 bits mode.

  Args:

    rootkey : HKEY_LOCAL_MACHINE, HKEY_CURRENT_USER … subkeypath : string like “softwaremicrosoftwindowscurrentversion”

  Returns:

    boolean

      >>> if reg_key_exists(HKEY_LOCAL_MACHINE,makepath('SOFTWARE','VideoLAN','VLC')):
      ...     print('VLC key exists')
      ???

setuphelpers.reg_openkey_noredir(rootkey, subkeypath, sam=131097, create_if_missing=False, noredir=True)

  Open the registry keysubkey with access rights sam

  The Wow6432Node redirector is disabled. So one can access 32 and 64 part or the registry even if python is running in 32 bits mode.

  Args:

    rootkey : HKEY_LOCAL_MACHINE, HKEY_CURRENT_USER … subkeypath : string like “softwaremicrosoftwindowscurrentversion” sam : a boolean combination of KEY_READ | KEY_WRITE create_if_missing : True to create the subkeypath if not exists, access rights will include KEY_WRITE noredir (boolean): True by default. disable the redirection to the 32 bits view of registry.

  Returns:

    keyhandle : a key handle for reg_getvalue and reg_set_value

      >>>

setuphelpers.reg_setvalue(key, name, value, type=1)

  Set the value of specified name inside ‘key’ folder

  key : handle of registry key as returned by reg_openkey_noredir() name : value name type : type of value (REG_SZ,REG_MULTI_SZ,REG_DWORD,REG_EXPAND_SZ)

setuphelpers.reg_value_exists(rootkey, subkeypath, value_name)

  Check if there is value named value_name in the subkeypath registry key of rootkey

  Args:

    rootkey (int): branch of registry HKEY_LOCAL_MACHINE,HKEY_USERS,HKEY_CURRENT_USER,HKEY_CURRENT_CONFIG subkeypath (str): path with back slashes like ‘SOFTWAREVideoLANVLC’ value_name (str) : value key like “Version”

  Returns:

    boolean: True if there is a value called value_name in the subkeypath of rootkey

      >>> if reg_value_exists(HKEY_LOCAL_MACHINE,makepath('SOFTWARE','VideoLAN','VLC'),'Version'):
      ...     print('VLC seems to be installed')
      ???

setuphelpers.register_dll(dllpath)

  Register a COM/OLE server DLL in registry (similar to regsvr32)

setuphelpers.register_ext(appname, fileext, shellopen, icon=None, otherverbs=[])

  Associates a file extension with an application, and command to open it

  Args:

    appname (str): descriptive name of the type of file / appication fileext (str): extension with dot prefix of

      >>> register_ext(
      ...     appname='WAPT.Package',
      ...     fileext='.wapt',
      ...     icon=r'c:\wapt\wapt.ico',
      ...     shellopen=r'"7zfm.exe" "%1"',otherverbs=[
      ...        ('install',r'"c:\wapt\wapt-get.exe" install "%1"'),
      ...        ('edit',r'"c:\wapt\wapt-get.exe" edit "%1"'),
      ...     ])
      >>>

setuphelpers.register_uninstall(uninstallkey, uninstallstring=None, win64app=None, quiet_uninstall_string=None, install_location=None, display_name=None, display_version=None, publisher=None, icon=None, installed_size=None)

  Register or update the uninstall entry in Windows registry, so that the application is displayed in Control Panel / Programs and features with correct informations

  Args:

    installed_size (int): in MB (default: converting bytes from control file to megabytes)

  Changed in version 2.3: now detect automatically if the app is win64

setuphelpers.register_windows_uninstall(package_entry, win64app=None)

  Add a uninstall entry in Windows registry for custom installer (for example: portable installation)

setuphelpers.registered_organization()

setuphelpers.registry_delete(root, path, valuename)

  Delete the valuename inside specified registry path

  The path can be either with backslash or slash

  Args:

    root : HKEY_LOCAL_MACHINE, HKEY_CURRENT_USER … path : string like “softwaremicrosoftwindowscurrentversion”

    > or “softwarewow6432nodemicrosoftwindowscurrentversion”

    valuename : None for value of key or str for a specific value like ‘CommonFilesDir’

setuphelpers.registry_deletekey(root, path, keyname, force=False, recursive=False)

  Delete the key under specified registry path and all its values.

  the path can be either with backslash or slash if the key has sub keys, the function fails.

  Args:

    root : HKEY_LOCAL_MACHINE, HKEY_CURRENT_USER … path : string like “software\microsoft\windows\currentversion”

    > or “software\wow6432node\microsoft\windows\currentversion”

    keyname : Name of key recursive: Whether the subkeys must be deleted recursively. If this is set to False and keyname has subkeys the function will fail.

      >>> from winsys import registry
      >>> py27 = registry.Registry(r'HKEY_LOCAL_MACHINE\Software\Python\PythonCore\2.7')
      >>> py27.copy(r'HKEY_LOCAL_MACHINE\Software\Python\PythonCore\test')
      >>> registry_deletekey(HKEY_LOCAL_MACHINE,'Software\\Python\\PythonCore','test')
      True

setuphelpers.registry_get(root, path, keyname, default=None)

  Return a string from registry

  Args:

    root : HKEY_LOCAL_MACHINE, HKEY_CURRENT_USER … path : string like “softwaremicrosoftwindowscurrentversion”

    > or “softwarewow6432nodemicrosoftwindowscurrentversion”

    keyname : None for value of key or str for a specific value like ‘CommonFilesDir’ the path can be either with backslash or slash

      >>> registry_get(HKEY_LOCAL_MACHINE,r'SYSTEM/CurrentControlSet/services/Tcpip/Parameters','Hostname').upper()
      u'HTLAPTOP'

setuphelpers.registry_readstring(root, path, keyname, default='')

  Return a string from registry

  Args:

    root : HKEY_LOCAL_MACHINE, HKEY_CURRENT_USER … path : string like “softwaremicrosoftwindowscurrentversion”

    > or “softwarewow6432nodemicrosoftwindowscurrentversion”

    keyname : None for value of key or str for a specific value like ‘CommonFilesDir’ the path can be either with backslash or slash

      >>> registry_readstring(HKEY_LOCAL_MACHINE,r'SYSTEM/CurrentControlSet/services/Tcpip/Parameters','Hostname').upper()
      u'HTLAPTOP'

setuphelpers.registry_set(root, path, keyname, value, type=None)

  Set the value of a key in registry, taking in account value type The path can be either with backslash or slash

  Args:

    root : HKEY_LOCAL_MACHINE, HKEY_CURRENT_USER … path : string like “softwaremicrosoftwindowscurrentversion”

    > or “softwarewow6432nodemicrosoftwindowscurrentversion”

    keyname : None for value of key or str for a specific value like ‘CommonFilesDir’ value : value (integer or string type) to put in keyname

  Returns:

setuphelpers.registry_setstring(root, path, keyname, value, type=1)

  Set the value of a string key in registry the path can be either with backslash or slash

  Args:

    root : HKEY_LOCAL_MACHINE, HKEY_CURRENT_USER … path : string like “softwaremicrosoftwindowscurrentversion”

    > or “softwarewow6432nodemicrosoftwindowscurrentversion”

    keyname : None for value of key or str for a specific value like ‘CommonFilesDir’ value : string to put in keyname

setuphelpers.remove_appx(package, default_user=True)

  Remove Windows AppX package from the computer environment, excluding NonRemovable packages.

  Args:

    package (str): AppX package name. You can use an asterisk (*) as a wildcard. default_user (bool): Remove AppX package from the Windows image to prevent installation for new users.

  New in version 2.2.

  Changed in version 2.5: No longer try to remove NonRemovable AppX package

setuphelpers.remove_desktop_shortcut(label)

  Remove a shortcut from the desktop of all users

  Args:

    label (str): label of shortcut without extension

setuphelpers.remove_file(path: str)

  Try to remove a single file or symlink log a warning msg if file doesn’t exist log a critical msg if file can’t be removed

  Args:

    path (str): path to file

      >>> remove_file(r'c:\tmp\fc.txt')

setuphelpers.remove_from_system_path(path)

  Remove a path from the global search PATH environment variable if it is set

setuphelpers.remove_metroapp(package)

  Uninstall and remove a metro package from the computer

  New in version 1.3.9.

setuphelpers.remove_netfirewallrule(rule_name)

  Remove Windows Firewall rules using New-NetFirewallRule cmdlet in PowerShell for Windows 10 and newer, or netsh advfirewall for older Windows versions.

  Args:

    rule_name (str): Display name of the firewall rules to remove.

  Returns:

    waptutils.RunOutput: The result of the command execution.

  New in version 2.5.

setuphelpers.remove_printer(name)

  Remove a printer by its name

  Args:

    name (str) : name of local printer to be deleted

  New in version 1.7.1.

      >>> remove_printer('Brother QL-1060')

setuphelpers.remove_programs_menu_folder(folder)

  Remove a folder from the start menu of all users

  Args:

    folder(str): folder to remove

setuphelpers.remove_programs_menu_shortcut(label, folder=None)

  Remove a shortcut from the start menu of all users

  Args:

    label (str): label of shortcut without extension folder (str): subfolder of Programs menu where the shortcut resides.

setuphelpers.remove_shutdown_script(cmd, parameters)

  Removes a local shutdown GPO script

      >>> index = remove_shutdown_script(r'c:\wapt\wapt-get.exe','update')

setuphelpers.remove_tree(*args, **kwargs)

  Convenience function to delete a directory tree, with any error not ignored by default. Pass ignore_errors=False to access possible errors.

  Args:

    path (str): path to directory to remove ignore_errors (boolean) : default to False. Set it to True to ignore exceptions on children deletion onerror (func) : hook called with (func, path, exc)

    > on each delete exception. Should raise if stop is required.

      >>> def print_error(func, path, error):
      >>>     print(u'Error when "%s" for "%s": "%s"' % (func.__name__, path, repr(error[1])))
      >>>
      >>> remove_tree(r'c:\tmp\target', onerror=print_error)

  Changed in version 1.5.1.17: ignore_errors default to False

setuphelpers.remove_user_appx(package)

  Remove Windows AppX package from user environment, excluding NonRemovable packages.

  Args:

    package (str): AppX Package name, asterisk character (*) can be used as wildcard

  New in version 2.3.

setuphelpers.remove_user_desktop_shortcut(label)

  Remove a shortcut from the desktop of current user

  Args:

    label (str): label of shortcut without extension

setuphelpers.remove_user_from_group(user, group)

  Remove membership from a local group for a user

setuphelpers.remove_user_programs_menu_folder(folder)

  Remove a folder from the start menu of current user

  Args:

    folder(str): folder to remove

setuphelpers.remove_user_programs_menu_shortcut(label, folder=None)

  Remove a shortcut from the start menu of current user

  Args:

    label (str): label of shortcut without extension

setuphelpers.replace_at_next_reboot(tmp_filename, target_filename)

  Schedule a file rename at next reboot using standard Windows PendingFileRenameOperations Creates a key in HKEY_LOCAL_MACHINESystemCurrentControlSetControlSession Manager with content :

  > PendingFileRenameOperations

  >   Data type : REG_MULTI_SZ Value data: ??c:tempwin32k.sys !??c:winntsystem32win32k.s

  Args:

    tmp_filename (str): Temporary path to file to rename (defaults to <target_filename>.pending) target_filename (str): Final target filename

setuphelpers.rsa_decrypt(data: bytes, rsakeypem: bytes, password: bytes = None) → bytes

  Decrypt data with private key and returns clear text data

setuphelpers.rsa_encrypt(data: bytes, certpem: bytes) → bytes

  Returns encrypted data with public key in X509 certificate

setuphelpers.rsa_encrypt_data(txt: str, list_crt: List[str])

setuphelpers.rsa_encrypted_data_str(txt: str, list_crt: List[str])

setuphelpers.run(cmd, shell=True, timeout=600, accept_returncodes=[0, 3010], on_write=None, pidlist=None, return_stderr=True, **kwargs)

  Run the command cmd in a shell and return the output and error text as string

  Args:

    cmd : command and arguments, either as a string or as a list of arguments shell (boolean) : True is assumed timeout (int) : maximum time to wait for cmd completion is second (default = 600)

    > a TimeoutExpired exception is raised if tiemout is reached.

    on_writecallback when a new line is printed on stdout or stderr by the subprocess

      func(unicode_line). arg is enforced to unicode

    accept_returncodes (list) : list of return code which are considered OK default = (0, 3010) pidlist (list): external list where to append the pid of the launched process. return_stderr (bool or list) : if True, the error lines are returned to caller in result.

    > if a list is provided, the error lines are appended to this list

    all other parameters from the psutil.Popen constructor are accepted

  Returns:
    RunOutputbytes like output of stdout and optionnaly stderr streams.

      returncode attribute

  Raises:

    CalledProcessError: if return code of cmd is not in accept_returncodes list TimeoutExpired: if process is running for more than timeout time.

  Changed in version 1.3.9: return_stderr parameters to disable stderr or get it in a separate list return value has a returncode attribute to

  Changed in version 1.4.0: output is not forced to unicode

  Changed in version 1.4.1: error code 1603 is no longer accepted by default.

  Changed in version 1.5.1: If cmd is unicode, encode it to default filesystem encoding before running it.

      >>> run(r'dir /B c:\windows\explorer.exe')
      'explorer.exe\r\n'

      >>> out = []
      >>> pids = []
      >>> def getlines(line):
      ...    out.append(line)
      >>> run(r'dir /B c:\windows\explorer.exe',pidlist=pids,on_write=getlines)
      u'explorer.exe\r\n'

      >>> print out
      ['explorer.exe\r\n']
      >>> try:
      ...     run(r'ping /t 127.0.0.1',timeout=3)
      ... except TimeoutExpired:
      ...     print('timeout')
      timeout

setuphelpers.run_as_administrator(afile, params=None)

  Launch with a runas verb to trigger a privileges elevation.

setuphelpers.run_notfatal(*cmd, **args)

  Runs the command and wait for it termination, returns output Ignore exit status code of command, return ‘’ instead

  Changed in version 1.4.0: output is now enforced to unicode

setuphelpers.run_powershell(cmd: str, output_format: Literal['json', 'text', 'xml'] = 'json', **kwargs)

  Run a command/script (possibly multiline) using powershell, return output in text format If format is ‘json’, the result is piped to ConvertTo-Json and converted back to a python dict for convenient use

  WARNING: This works only with powershell >= 3

  Args:

    output_format (str): set output format as json (default) or xml (ElementTree object) or text

  Returns:

    str or dict or list

  New in version 1.3.9.

setuphelpers.run_powershell_from_file(file, output_format='json', **kwargs)

  Run a command/script from file using powershell, return output in text format If format is ‘json’, the result is piped to ConvertTo-Json and converted back to a python dict for convenient use

  New in version 1.3.9.

setuphelpers.run_powershell_script(script_filename, output_format: Literal['json', 'text', 'xml'] = 'json', **kwargs)

  Run a script file using powershell, return output in text format If format is ‘json’, the result is piped to ConvertTo-Json and converted back to a python dict for convenient use

  Args:

    output_format (str): set output format as json (default) or xml (ElementTree object) or text

  Returns:

    str or dict or list

  New in version 2.6.0.

setuphelpers.run_task(name)

  Launch immediately the Windows Scheduled task

setuphelpers.running_as_admin()

setuphelpers.running_as_system()

  Dirty way to check if current process is running as system user

setuphelpers.running_on_ac()

  Return True if computer is connected to AC power supply

  New in version 1.3.9.

setuphelpers.sendto()

  What folder holds the SendTo shortcuts(from the Context Menu)?

setuphelpers.service_delete(service_name)

setuphelpers.service_installed(service_name)

  Return True if the service is installed

setuphelpers.service_is_running(service_name)

  Return True if the service is running

      >>> state = service_is_running('waptservice')

setuphelpers.service_is_stopped(service_name)

  Return True if the service is running

      >>> state = service_is_running('waptservice')

setuphelpers.service_list()

setuphelpers.service_restart(service_name, timeout=15)

  Restart a service by its service name

setuphelpers.service_start(service_name, timeout=15)

  Start a service by its service name

setuphelpers.service_stop(service_name, timeout=15)

  Stop a service by its service name

setuphelpers.set_computer_description(description)

  Change the computer descrption

setuphelpers.set_environ_variable(name, value, type=2, user=False)

  Add or update a system wide persistent environment variable

      >>> set_environ_variable('WAPT_HOME','c:\\wapt')
      >>> import os
      >>> os.environ['WAPT_HOME']
      'c:\\wapt'

setuphelpers.set_file_hidden(path: str, hidden: bool = True)

  Set the hidden attribute of file located at path Utility function for shutdown gpo script

  Args:

    path (str): path to the file hidden (bool): Whether the hidden attribute must be set or not

setuphelpers.set_file_visible(path: str)

  Unset the hidden attribute of file located at path

  Utility function for shutdown gpo script

  Args:

    path (str): path to the file

setuphelpers.set_service_start_mode(service_name, start_mode, change_state=True, raise_error=False)

  Changing start mode of a service and changing his running status accordingly Usable values: ‘Auto’, ‘Manual’, ‘Disabled’ Informations: https://msdn.microsoft.com/en-us/library/aa384896(v=vs.85).aspx

  Changed in version 2.2: Now interact on the running state

  Changed in version 2.5: Add raise_error flag

setuphelpers.shell_launch(cmd)

  Launch a command (without arguments) but doesn’t wait for its termination

      >>> with open('c:/tmp/test.txt','w') as f:
      ...     f.write('Test line')
      >>> shell_launch('c:/tmp/test.txt')

setuphelpers.showmessage(msg)

setuphelpers.shutdown_scripts_ui_visible(state=True)

  Enable or disable the GUI for windows shutdown scripts

      >>> shutdown_scripts_ui_visible(None)
      >>> shutdown_scripts_ui_visible(False)
      >>> shutdown_scripts_ui_visible(True)

setuphelpers.start_menu(common=0)

  What folder holds the Start Menu shortcuts?

setuphelpers.startup(common=0)

  What folder holds the Startup shortcuts(from the Start Menu)?

setuphelpers.system32() → str

  returns the path of system32directory

  Returns:

    str: path to system32 directory

      >>> print(system32())
      C:\WINDOWS\system32

setuphelpers.task_exists(name)

  Return true if a sheduled task names ‘name.job’ is defined

setuphelpers.time2display(adatetime: datetime) → str

setuphelpers.uac_enabled()

  Return True if UAC is enabled

  New in version 1.3.9.

setuphelpers.uninstall_cmd(guid)

  return the (quiet) command stored in registry to uninstall a software given its registry key

      >>> old_softs = installed_softwares('notepad++')
      >>> for soft in old_softs:
      ...     print uninstall_cmd(soft['key'])
      [u'C:\\Program Files (x86)\\Notepad++\\uninstall.exe', '/S']

setuphelpers.uninstall_key_exists(uninstallkey, keywords=None, name=None)

  Check if the uninstallkey is present in win32 / win64 registry

setuphelpers.unpin_from_taskbar(program_path: str) → None

  Unpin a program from the taskbar (windows only)

setuphelpers.unregister_dll(dllpath)

  Unregister a COM/OLE server DLL from registry

setuphelpers.unregister_uninstall(uninstallkey, win64app=None)

  Removes the uninstallkey from the registry

  Changed in version 2.3: now detect automatically if the app is win64

  Changed in version 2.5: now includes empty_names

setuphelpers.unset_environ_variable(name, user=True)

  Remove a system wide persistent environment variable if it exist. Fails silently if it doesn’t exist

setuphelpers.unzip(zipfn: str, target: Optional[str] = None, filenames: Optional[List[str]] = None, extract_with_full_paths: bool = True)

  Unzip the files from zipfile with patterns in filenames to target directory

  Args:

    zipfn (str) : path to zipfile. (can be relative to temporary unzip location of package) target (str) : target location. Defaults to dirname(zipfile) + basename(zipfile) filenames (str or list of str): list of filenames / glob patterns (path sep is normally a slash) extract_with_full_paths (bool): keeping or not the subfolders of the archive as is

  Returns:

    list : list of extracted files

      >>> unzip(r'C:\example\tis-7zip_9.2.0-15_all.wapt')
      ['C:\\example\\tis-7zip_9.2.0-15_all\\7z920-x64.msi',
       'C:\\example\\tis-7zip_9.2.0-15_all\\7z920.msi',
       'C:\\example\\tis-7zip_9.2.0-15_all\\setup.py',
       'C:\\example\\tis-7zip_9.2.0-15_all\\WAPT/control',
       'C:\\example\\tis-7zip_9.2.0-15_all\\WAPT/wapt.psproj',
       'C:\\example\\tis-7zip_9.2.0-15_all\\WAPT/manifest.sha256',
       'C:\\example\\tis-7zip_9.2.0-15_all\\WAPT/signature']

      >>> unzip(r'C:\example\tis-7zip_9.2.0-15_all.wapt', filenames=['*.msi','*.py'])
      ['C:\\example\\tis-7zip_9.2.0-15_all\\7z920-x64.msi',
       'C:\\example\\tis-7zip_9.2.0-15_all\\7z920.msi',
       'C:\\example\\tis-7zip_9.2.0-15_all\\setup.py']

      >>> unzip(r'C:\example\tis-7zip_9.2.0-15_all.wapt', target='test', filenames=['*.msi','*.py'])
      ['C:\\example\\test\\7z920-x64.msi',
       'C:\\example\\test\\7z920.msi',
       'C:\\example\\test\\setup.py']

      >>> unzip(r'C:\example\tis-7zip_9.2.0-15_all.wapt', filenames='WAPT/*')
      ['C:\\example\\tis-7zip_9.2.0-15_all\\WAPT/control',
       'C:\\example\\tis-7zip_9.2.0-15_all\\WAPT/wapt.psproj',
       'C:\\example\\tis-7zip_9.2.0-15_all\\WAPT/manifest.sha256',
       'C:\\example\\tis-7zip_9.2.0-15_all\\WAPT/signature']

      >>> unzip(r'C:\example\tis-7zip_9.2.0-15_all.wapt', filenames='WAPT/control')
      ['C:\\example\\tis-7zip_9.2.0-15_all\\WAPT\\control']

      >>> unzip('tis-7zip_9.2.0-15_all.wapt', target='.', filenames='WAPT/control')
      ['.\\WAPT\\control']

      >>> unzip(r'C:\example\tis-7zip_9.2.0-15_all.wapt', target=r'C:\example\', filenames='WAPT/control')
      ['C:\\example\\WAPT\\control']

      >>> unzip('tis-7zip_9.2.0-15_all.wapt', target=basedir, filenames='WAPT/control')
      ['C:\\example\\WAPT\\control']

      >>> unzip(r'C:\example\tis-7zip_9.2.0-15_all.wapt', filenames='WAPT/control', extract_with_full_paths=False)
      ['C:\\example\\control']

  New in version 1.3.11.

  Changed in version 2.2: added extract_with_full_paths parameter

setuphelpers.user_appdata()

  Return the roaming appdata profile of current user

  Returns:

    str: path like u’C:\Users\username\AppData\Roaming’

setuphelpers.user_desktop()

  Return path to current logged in user desktop

      >>> user_desktop()
      u'C:\\Users\\htouvet\\Desktop'

setuphelpers.user_home_directory()

setuphelpers.user_local_appdata()

  Return the local appdata profile of current user

  Returns:

    str: path like u’C:\Users\user\AppData\Local’

setuphelpers.wait_uninstallkey_absent(key=None, max_loop=120, keywords=None, name=None, raise_on_timeout=False)

setuphelpers.wait_uninstallkey_present(key=None, max_loop=120, keywords=None, name=None, raise_on_timeout=False)

setuphelpers.wget(url, target=None, printhook=None, proxies=None, connect_timeout=10, download_timeout=None, verify_cert=None, referer=None, user_agent=None, cert=None, resume=False, md5=None, sha1=None, sha256=None, cache_dir=None, requests_session=None, limit_bandwidth=None)

  Copy the contents of a file from a given URL to a local file.

  Args:

    url (str): URL to document target (str) : full file path of downloaded file. If None, put in a temporary dir with supplied url filename (final part of url) proxies (dict) : proxies to use. eg {‘http’:’http://wpad:3128’,’https’:’http://wpad:3128’} timeout (int) : seconds to wait for answer before giving up auth (list) : (user,password) to authenticate with basic auth verify_cert (bool or str) : either False, True (verify with embedded CA list), or path to a directory or PEM encoded CA bundle file

    > to check https certificate signature against.

    cert (list) : tuple/list of (x509certfilename,pemkeyfilename,key password) for authenticating the client. If key is not encrypted, password must be None referer (str): user_agent: resume (bool): md5 (str) : sha1 (str) : sha256 (str) : cache_dir (str) : if file exists here, and md5 matches, copy from here instead of downloading. If not, put a copy of the file here after downloading.

    requests_session (request.Session) : predefined request session to use instead of building one from scratch from proxies, cert, verfify_cert

  Returns:

    str : path to downloaded file

      >>> respath = wget('http://wapt.tranquil.it/wapt/tis-firefox_28.0.0-1_all.wapt','c:\\tmp\\test.wapt',proxies={'http':'http://proxy:3128'})
      ???
      >>> os.stat(respath).st_size>10000
      True
      >>> respath = wget('http://localhost:8088/runstatus','c:\\tmp\\test.json')
      ???

setuphelpers.wgets(url, proxies: Optional[dict] = None, verify_cert=None, referer=None, user_agent=None, timeout=None, cert=None, requests_session=None, as_json=False) → str

  Return the content of a remote resource as a string / bytes or dict with a http get request.

  Raise an exception if remote data can’t be retrieved.

  Args:

    url (str): http(s) url proxies (dict): proxy configuration as requests requires it {‘http’: url, ‘https’:url} verify_cert (bool or str) : verfiy server certificate, path to trusted CA bundle cert (tuple of 3 str) : (cert_path, key_path, key password) client side authentication.

    requests_session (request.Session) : predefined request session to use instead of building one from scratch

  Returns:

    str or bytes or dict : content of remote resource. str or bytes or json depending of the encoding and the Content-Type.

      >>> data = wgets('https://wapt/ping')
      >>> "msg" in data
      True

setuphelpers.win32com_ensure_dispatch_patch(prog_id)

setuphelpers.win_startup_info()

  Return the applications started at boot or login

  Returns:
    dict{‘common_startup’: [{‘command’: ‘’,

      > ‘name’: ‘’},]

      ‘run’: [{‘command’: ‘’,

        ‘name’: ‘’},]

setuphelpers.wincomputername()

setuphelpers.windomainname()

setuphelpers.windows_version(members_count=3)

  Same than windows_version_from_WMI() but get information for windows 10 in registry (it’s faster)

  New in version 1.3.5.

  Changed in version 1.6.2.5: members_count (int) : default to 3

  Changed in version 2.3: now getting the correct UBR (Update Build Revision) shown with “winver” command

setuphelpers.wmi_as_struct(wmi_object, exclude_subkeys=['OEMLogoBitmap'])

  Convert a wmi object to a simple python list/dict structure

setuphelpers.wmi_info(keys=['Win32_ComputerSystem', 'Win32_ComputerSystemProduct', 'Win32_BIOS', 'Win32_NetworkAdapter', 'Win32_Printer', 'Win32_VideoController', 'Win32_LogicalDisk', 'Win32_OperatingSystem', 'Win32_DesktopMonitor', 'Win32_USBController', 'Win32_DiskDrive', 'Win32_Volume'], exclude_subkeys=['OEMLogoBitmap'], **where)

  Get WMI machine informations as dictionaries

setuphelpers.wmi_info_basic()

  Return uuid, serial, model, vendor from WMI

  Returns:

    dict: minimal informations for wapt registration

      >>> r = wmi_info_basic()
      >>> 'System_Information' in r
      True

setuphelpers.wua_agent_version()

# Version Class

class setuphelpers.Version(version, members_count: Optional[int] = None)

  Version object of form 0.0.0 can compare with respect to natural numbering and not alphabetical

  Args:

    version (str) : version string member_count (int) : number of version memebers to take in account.

    > If actual members in version is less, add missing memeber with 0 value If actual members count is higher, removes last ones.

      >>> Version('0.10.2') > Version('0.2.5')
      True
      >>> Version('0.1.2') < Version('0.2.5')
      True
      >>> Version('0.1.2') == Version('0.1.2')
      True
      >>> Version('7') < Version('7.1')
      True

  Changed in version 1.6.2.5: truncate version members list to members_count if provided.

  sortable_str() → str

    Output a str suitable for direct ordering members are converted to a chars hex padded with zero on the left. If member is not a digit, it is padded to a 8 chars string padded with spaces on the right.

# Setupdevhelpers

setupdevhelpers.ask_directory(title='Select folder', initial_dir='', raise_error=False)

  Asks the user to select a folder using a directory dialog and returns the path of that folder.

  Args:

    title (str): Specifies the title of the directory dialog window. Default value is “Select folder”. initial_dir (str): Specifies the initial path of the directory dialog. Default is last provided. raise_error (bool): Whether to raise an error if no folder is selected.

  Returns:

    The path of the selected folder.

setupdevhelpers.ask_filename(title='Select file', initial_dir='', filename='*.*', filter='All files (*.*)|*.*', raise_error=False)

  This function asks the user to select a file using a filename dialog and returns the path of that file.

  Args:

    title (str): The title for the dialog. initialdir (str): The initial directory path. Default is last provided. filename (str): The default file name. Default is “.”. filter (str): The filter by description and extension. Default is “All files (.)|*.*”. raise_error (bool): Whether to raise an error if the user cancels the dialog. Default is True.

  Returns:

    str: The path of the selected file.

  Raises:

    ValueError: If the user cancels the dialog and raise_error is True.

setupdevhelpers.ask_grid(title, dict_input, result_type=0, metadata='', search_label='Search', stay_on_top=False, raise_error=False)

  Opens a dialog box with an action input.

  Args:

    title (str): The name of the title to display in the dialog box. dict_input (dict): A dictionary of input values to display in the dialog box. result_type (str or int): The type of result to display in the dialog box. Currently supported options are:

    > - “GRT_ALL” or (0) to return the whole grid

    > - “GRT_SELECTED” or (1) to return the selected rows

    metadata (str of a json): Additional metadata to display in the dialog box. search_label (str): The label for the search button in the dialog box. stay_on_top (bool): Whether to keep the dialog box on top of other windows. raise_error (bool): Whether to raise an error if no response is given by the user.

  Returns:

    The result of the dialog box.

setupdevhelpers.ask_input(title, text, default='', stay_on_top=False, raise_error=False)

  Opens a dialog box with an action input.

  Args:

    title (str): The title for the dialog. text (str): Indicates which value the user should type. default (str): The default value if the user does not want to type anything. stay_on_top (bool): Indicates if the dialog box will always stay on top. Default is False. raise_error (bool): Whether to raise an error if no response is given by the user.

  Returns:

    The response from the dialog box.

setupdevhelpers.ask_message(title, text, flags=None, raise_error=False)

  Opens a message box with customizable buttons and icons.

  Args:

    title (str): The title to display in the message box. text (str): The message text to display in the message box. flags (int): Options for buttons and icons. You can combine a message and an icon by adding their corresponding

    > integer values together. Possible message options: - MB_OK (0): OK button - MB_OKCANCEL (1): OK and Cancel buttons - MB_ABORTRETRYIGNORE (2): Abort, Retry, and Ignore buttons - MB_YESNOCANCEL (3): Yes, No, and Cancel buttons - MB_YESNO (4): Yes and No buttons

    > Possible icon options: - MB_ICONERROR (16): Error icon - MB_ICONQUESTION (32): Question icon - MB_ICONWARNING (48): Warning icon - MB_ICONINFORMATION (64): Information icon

    > To combine a message and an icon, add their integer values together. For example, to display an OK button with an information icon, use: 0 + 64 (MB_OK + MB_ICONINFORMATION).

    > Note: For more details and additional options, refer to the documentation at: https://www.functionx.com/delphi/msgboxes/messagebox.htm

    raise_error (bool): Whether to raise an error if no response is given by the user.

  Returns:

    The response code indicating the user’s choice. Possible return values: - ID_OK (1) - ID_CANCEL (2) - ID_ABORT (3) - ID_RETRY (4) - ID_IGNORE (5) - ID_YES (6) - ID_NO (7)

setupdevhelpers.bs_find(url, element, attribute=None, value=None, user_agent=None, proxies=None, features='html.parser', **kwargs)

  Parse an HTML or XML web page with BeautifulSoup and retrieve the first matching result.

  Args:

    url (str): URL of the web page or string to parse. element (str): Searched element. attribute (str): Selected attribute of the element. value (str): Value of the selected attribute. user_agent (str): Specify a user-agent if needed. proxies (dict): Specify proxies if needed. features (str): BeautifulSoup feature to use. **kwargs: Additional parameters for the requests library.

  Returns:

    bs4.element.Tag or None: The first matching element, or None if no match is found.

  Examples:

        >>> bs_find('https://www.w3.org/', 'a', 'title', 'Open Web Platform testing')['href']
        'https://web-platform-tests.org/'

        >>> bs_find('https://www.w3.org/', 'span', 'class', 'alt-logo').string
        'W3C'

  New in version 2.0.

  Changed in version 2.5: Function can now parse string content of a page or reparse a “bs_result”. It is now possible to parse a specific attribute.

setupdevhelpers.bs_find_all(url, element, attribute=None, value=None, user_agent=None, proxies=None, features='html.parser', **kwargs)

  Parse an HTML or XML web page with BeautifulSoup and retrieve a list of all matching results.

  Args:

    url (str): URL of the web page or string to parse. element (str): Searched element. attribute (str): Selected attribute of the element. value (str): Value of the selected attribute. user_agent (str): Specify a user-agent if needed. proxies (dict): Specify proxies if needed. features (str): BeautifulSoup feature to use. **kwargs: Additional parameters for the requests library.

  Returns:

    list: List of bs4.element.Tag objects representing the matching elements.

  Examples:

        >>> bs_find_all('https://www.w3.org/', 'a', 'title', 'Open Web Platform testing')[0]['href']
        'https://web-platform-tests.org/'

        >>> bs_find_all('https://www.w3.org/', 'span', 'class', 'alt-logo')[0].string
        'W3C'

  New in version 2.0.

  Changed in version 2.5: Function can now parse string content of a page or reparse a “bs_result”. It is now possible to parse a specific attribute.

setupdevhelpers.complete_control_categories(control)

  Requesting that the user supply package categories for the control.categories field if empty or Template is selected Args:

  > control (str or waptpackage.PackageEntry): The path of control file or his PackageEntry call

setupdevhelpers.complete_control_description(control, control_description='', silent=False, blank_str='', maximum_length=None)

  Updates the control description field with the provided description.

  Args:

    control (str or waptpackage.PackageEntry): The path of control file or his PackageEntry call control_description (str): The description to be set for the control.description field. silent (bool): If True, no user input dialog will be displayed. (default: False) blank_str (str): If the description contains this string, it will be cleared. (default: “” => do not clear) maximum_length (int): If the description has more characters than the defined value, the function will try to reduce it.

  Returns:

    str: The updated control description.

setupdevhelpers.complete_control_descriptions(control, control_descriptions_dict={'description': '', 'description_de': '', 'description_es': '', 'description_fr': '', 'description_it': '', 'description_nl': '', 'description_pl': '', 'description_pt': '', 'description_ru': ''}, silent=False, blank_str='')

  Updates the control description field with the provided description.

  Args:

    control_description (str): The description to be set for the control.description field. silent (bool): If True, no user input dialog will be displayed. (default: False) blank_str (str): If the description contains this string, it will be cleared. (default: “”)

  Returns:

    str: The updated control description.

setupdevhelpers.complete_control_impacted_process(control, program_dir='')

  Complete package control.impacted_process.

setupdevhelpers.complete_control_min_wapt_version(control, min_wapt_version='2.3', silent=False)

  Complete package control.min_wapt_version.

setupdevhelpers.complete_control_name(control, control_name='', silent=False)

  Requesting that the user provide a package name to be entered into control.name field

  Args:

    control (str or waptpackage.PackageEntry): The path of control file or his PackageEntry call control_name (str) : Prefilled control_name (default: control.name whitout “template” word) silent (bool) : If True, no user input dialog will be displayed. (default: False)

setupdevhelpers.complete_control_package(control, control_package='', silent=False, remove_template_base_files=False)

  Requesting that the user provide a package name to be entered into the control.package field, and offering the possibility of removing the base files (icon.png and changelog.txt) for template package usage

  Args:

    control (str or waptpackage.PackageEntry): The path of control file or his PackageEntry call control_package (str) : Prefilled control_package (default: actual control_package) silent (bool) : If True, no user input dialog will be displayed. (default: False) remove_template_base_files (bool): Removes base files if parameter is True and str(“template”) in control.package (default: False)

setupdevhelpers.complete_control_version(control, version, inc_build=False)

  Complete package control.version. Return if the package have been updated

setupdevhelpers.convert_control_path_to_dir(any_path)

  Converts the control file path to a directory path by removing the ‘WAPT/control’ suffix.

  Args:

    any_path (str): The input file path.

  Returns:

    str: The converted directory path with the ‘WAPT/control’ suffix removed.

  Example:

        >>> convert_control_path_to_dir('/path/to/some_directory/WAPT/control')
        '/path/to/some_directory'

setupdevhelpers.format_dict_to_grid(dict_data, key_name='parameter', value_name='value')

setupdevhelpers.format_grid_to_dict(dict_list_data, key_name='parameter', value_name='value')

setupdevhelpers.get_7z_path()

  Check if the 7zip binary path exists and returns it.

  Returns:

    str: path to the 7zip binary

setupdevhelpers.get_control_dict(control)

  Load the control information of a package as dict based on its PackageEntry, its control file, or its package dir.

  Args:

    control (PackageEntry or str): The PackageEntry, the control file path, or the package dir path.

  Returns:

    dict: A dictionary containing the control information of the package.

setupdevhelpers.get_file_extension(filename)

setupdevhelpers.get_proxies_from_wapt_console()

  Return proxy information from the current user WAPT console

      >>> get_proxies_from_wapt_console()
      {'http': 'http://srvproxy.ad.domain.lan:8080',
      'https': 'http://srvproxy.ad.domain.lan:8080'}

setupdevhelpers.get_size(any_path)

  Calculate the total size of files and directories in a path, including subdirectories.

  Args:

    any_path (str): The directory or file path to start calculating the size from.

  Returns:

    int: Total size in bytes.

  Raises:

    FileNotFoundError: If the specified path does not exist.

setupdevhelpers.is_url(x)

setupdevhelpers.remove_outdated_binaries(version, list_extensions=['exe', 'msi', 'deb', 'rpm', 'dmg', 'pkg', 'part'], filename_contains=None)

  Remove files based on the version contained in his filename, failing over on file version on compatible OSes

  Args:

    version (str): version number of keeped files list_extensions (str or list of str): file extensions of compared files filename_contains (str or list of str): Part of the filename that must be contained (useful for distinguishing architecture and os)

  Returns:

    list: list of deleted files

  New in version 2.0.

  Changed in version 2.2: Now returns removed files, now checking .exe and .msi file versions

setupdevhelpers.remove_tree_for_all_users(user_folder_relative_path, ignored_users=None, ignore_system_users=True)

  Remove a specific folder or folders for all user profiles.

  Args:

    user_folder_relative_path (str): Relative path to the user folder. Glob patterns can be used. ignored_users (str or list of str): Ignore specified users. ignore_system_users (bool): Ignore default, public, all users, etc. (True by default).

  Returns:

    list: List of deleted folders.

      >>> print(remove_tree_for_all_users(makepath(".vscode", "extensions", "ms-toolsai.jupyter-*")))
      ['C:\Users\username\.vscode\extensions\ms-toolsai.jupyter-2022.2.1001817079', 'C:\Users\username\.vscode\extensions\ms-toolsai.jupyter-keymap-1.0.0', 'C:\Users\username\.vscode\extensions\ms-toolsai.jupyter-renderers-1.0.6']

      >>> print(remove_tree_for_all_users(makepath(".vscode", "extensions", "ms-toolsai.jupyter-")))
      []

      >>> print(remove_tree_for_all_users(makepath(".vscode", "extensions", "ms-toolsai.jupyter-[a-z]*")))
      ['C:\Users\username\.vscode\extensions\ms-toolsai.jupyter-keymap-1.0.0', 'C:\Users\username\.vscode\extensions\ms-toolsai.jupyter-renderers-1.0.6']

      >>> print(remove_tree_for_all_users(makepath(".vscode", "extensions", "ms-toolsai.jupyter-1.0.0")))
      ['/home/username/.vscode/extensions/ms-toolsai.jupyter-keymap-1.0.0']

setupdevhelpers.unzip_with_7zip(filename, target=None, filenames=[], extract_with_full_paths=True, recursive=True)

  Extract the files from an archive file with 7zip with patterns in filenames to target directory

  Args:

    filename (str): path to archive file. (can be relative to temporary unzip location of package) target (str): archive content to target dir location (dir will be created if needed). Default: dirname(archive file) + basename(archive file) filenames (str or list of str): list of filenames / glob patterns (path sep is normally a slash) extract_with_full_paths (bool): keeping or not the subfolders of the archive as is recursive (bool): looking or not for filenames recursively

  Returns:

    None

  New in version 2.0.

  Changed in version 2.2: changed default target location to make it correspond with unzip()

# Waptpackage

exception waptpackage.EWaptBadControl

  Bases: `EWaptException`

exception waptpackage.EWaptBadPackageAttribute

  Bases: `EWaptException`

exception waptpackage.EWaptBadSetup

  Bases: `EWaptException`

exception waptpackage.EWaptBadSignature

  Bases: `EWaptException`

exception waptpackage.EWaptConfigurationError

  Bases: `EWaptException`

exception waptpackage.EWaptConflictingPackage(msg, install_status='ERROR', retry_count=None)

  Bases: `EWaptInstallError`

exception waptpackage.EWaptCorruptedFiles

  Bases: `EWaptException`

exception waptpackage.EWaptDiskSpace

  Bases: `EWaptException`

exception waptpackage.EWaptDownloadError

  Bases: `EWaptException`

exception waptpackage.EWaptException

  Bases: `Exception`

exception waptpackage.EWaptInstallError(msg, install_status='ERROR', retry_count=None)

  Bases: `EWaptException`

  Exception raised during installation of package msg is logged in local install database if retry_count is None, install will be retried indefinitely until success else install is retried at most retry_count times.

exception waptpackage.EWaptInstallPostponed(msg, install_status='POSTPONED', retry_count=5, grace_delay=3600)

  Bases: `EWaptInstallError`

exception waptpackage.EWaptMissingLocalWaptFile

  Bases: `EWaptException`

exception waptpackage.EWaptNeedsNewerAgent

  Bases: `EWaptException`

exception waptpackage.EWaptNotAPackage

  Bases: `EWaptException`

exception waptpackage.EWaptNotSigned

  Bases: `EWaptException`

exception waptpackage.EWaptNotSourcesDirPackage

  Bases: `EWaptException`

exception waptpackage.EWaptPackageSignError

  Bases: `EWaptException`

exception waptpackage.EWaptUnavailablePackage(msg, install_status='ERROR', retry_count=None)

  Bases: `EWaptInstallError`

class waptpackage.HostCapabilities(from_dict=None, from_string_filter=None, **kwargs)

  Bases: `BaseObjectClass`

  as_dict()
  fingerprint()
  get_package_request_filter()

    Returns a filter for package search in repositories

    Returns:

      PackageRequest

  has_matching_target(package_entry)
  is_matching_package(package_entry, for_datetime=None, errors_list=None)

    Check if package_entry is matching the current capabilities and restrictions

class waptpackage.PackageEntry(package='', version='0', repo='', waptfile=None, section='base', **kwargs)

  Bases: `BaseObjectClass`

  Manage package attributes coming from either control files in WAPT package, local DB, or developement dir.

  Methods to build, unzip, sign or check a package. Methods to sign the control attributes and check them.

      >>> pe = PackageEntry('testgroup','0')
      >>> pe.depends = 'tis-7zip'
      >>> pe.section = 'group'
      >>> pe.description = 'A test package'
      >>> print(pe.ascontrol())
      package           : testgroup
      version           : 0
      architecture      : all
      section           : group
      priority          : optional
      maintainer        :
      description       : A test package
      depends           : tis-7zip
      conflicts         :
      maturity          :
      locale            :
      min_wapt_version  :
      sources           :
      installed_size    :
      signer            :
      signer_fingerprint:
      signature_date    :
      signed_attributes :

      >>>

  add_conflicts(to_add)
  add_depends(to_add)
  property all_attributes
  as_control_bytes()

    Return this package entry metadata as bytes as saved in package control file

    Return:

      bytes: lines with key: value

  as_dict()
  as_key()
  as_package_request()
  as_zipfile(mode='r')

    Return a CustomZipFile for this package for read only operations

  ascontrol(with_repo_attributes=False, with_empty_attributes=False)

    Return control attributes and values as stored in control packages file

    Each attribute on a line with key : value If value is multiline, new line begin with a space.

    Args:

      with_repo_attributes (bool) : if True, include md5sum and filename (for Packages index only) with_empty_attributes (bool) : weither to include attribute with empty value too or only

      > non empty and/or signed attributes

    Returns:

      str: lines of attr: value

  asrequirement()

    Return package and version for designing this package in depends or install actions

    Returns:

      str: “packagename (=version)”

  build_management_package(target_directory=None)

    Build the WAPT package from attributes only, without setup.py stores the result in target_directory.

    self.sourcespath must be None. Package will contain only a control file.

    Args:
      target_directory (str): where to create Zip wapt file.

        if None, temp dir will be used.

    Returns:

      str: path to zipped Wapt file. It is unsigned.

        >>> pe = PackageEntry('testgroup','0',description='Test package',maintainer='Hubert',sources='https://dev/svn/testgroup',architecture='x86')
        >>> waptfn = pe.build_management_package()
        >>> key = SSLPrivateKey('c:/private/htouvet.pem',password='monmotdepasse')
        >>> crt = SSLCertificate('c:/private/htouvet.crt')
        >>> pe.sign_package(crt,key)
        >>> pe.unzip_package()
        'c:\users\htouvet\appdata\local\temp\waptob4gcd'
        >>> ca = SSLCABundle('c:/wapt/ssl')
        >>> pe.check_control_signature(ca)
        <SSLCertificate cn=u'htouvet' issuer=u'tranquilit-ca-test' validity=2017-06-28 - 2027-06-26 Code-Signing=True CA=True>

  build_manifest(exclude_filenames=None, block_size=1048576, forbidden_files=[], waptzip=None, excludes=[]) → Dict[str, str]

    Calc the manifest of a wapt package

    Args:
      forbidden_files (list): list of relative files which must not be present for the manifest to be built

        (if one is found, build fails)

      exclude_filenames (list) : list of exact (relative to package root with forward slashes) filepathes to exclude from manifest. excludes (list) : list of file / dir patterns to exclude, whatever level they are in the file hierarchy

    Returns:

      dict: {filepath:shasum,}

  build_package(excludes=[], target_directory=None, excludes_full=['.svn', '.git', 'setup.pyc', 'update_package.pyc', '__pycache__/setup.cpython-39.pyc', '__pycache__/update_package.cpython-39.pyc'])

    Build the WAPT package, stores the result in target_directory Zip the content of self.sourcespath directory into a zipfile named with default package filename based on control attributes.

    Update filename attribute. Update localpath attribute with result filepath.

    Args:

      excludes (list) : list of patterns for source files to exclude from built package. target_directory (str): target directory where to store built package.

      > If None, use parent directory of package sources dircetory.

      excludes_full (list) : list of exact (relative to package root) filepathes to exclude from Zip.

    Returns:

      str: full filepath to built wapt package

  call_setup_hook(hook_name='session_setup', wapt_context=None, params=None, force=None, user=None)

    Calls a hook in setuppy given a wapt_context

    Set basedir, control, and run context within the function context.

    Args:

      hook_name (str): name of function to call in setuppy wapt_context (Wapt) : run context

    Returns:

      output of hook.

    Changes:

    > 1.6.2.1: the called hook is run with Disabled win6432 FileSystem redirection

  change_depends_conflicts_prefix(new_prefix)

    Change prefix of package name to new_prefix in depends and conflicts csv lists and return True if it was really changed.

    Args:

      new_prefix (str): new prefix to put in package names

    Returns:

      bool

  change_prefix(new_prefix)

    Change prefix of package name to new_prefix and return True if it was really changed.

  check_control_signature(trusted_bundle, signers_bundle=None)

    Check in memory control signature against a list of public certificates

    Args:

      trusted_bundle (SSLCABundle): Trusted certificates. : packages certificates must be signed by one of this bundle. signers_bundle : Optional. List of potential packages signers certificates chains.

      > When checking Packages index, actual packages are not available, only certificates embedded in Packages index. Package signature are checked against these certificates looking here for potential intermediate CA too. and matching certificate is checked against trusted_bundle.

    Returns:

      SSLCertificate : matching trusted package’s signers SSLCertificate

        >>> from waptpackage import *
        >>> from common import SSLPrivateKey,SSLCertificate
        >>> k = SSLPrivateKey('c:/private/test.pem')
        >>> c = SSLCertificate('c:/private/test.crt')

        >>> p = PackageEntry('test',version='1.0-0')
        >>> p.depends = 'test'
        >>> p._sign_control(k,c)
        >>> p.check_control_signature(c)

        >>> p.check_control_signature(SSLCABundle('c:/wapt/ssl'))

  check_package_attributes(remove_min_max_os=False)
  check_package_signature(trusted_bundle, ignore_missing_files=False)

    Check - hash of files in unzipped package_dir with list in package’s manifest file - try to decrypt manifest signature with package’s certificate - check that the package certificate is issued by a know CA or the same as one the authorized certitificates.

    Args:

      trusted_bundle (SSLCABundle) : Local certificates store. Certificates in trusted_bundle.trusted_certificates are trusted. ignore_missing_files (bool): whether to raise exception for missing files. Useful to check stripped down packages when remote resigning

    Returns:

      SSLCertificate : matching certificate

    Raises:

      Exception if no certificate match is found.

  delete_localsources()

    Remove the unzipped local directory

  fingerprint()
  get(name, default=None)

    Get PackageEntry property.

    Args:

      name (str): property to get. name is forced to lowercase. default (any) : value to return in case the property doesn’t not exist.

    Returns:

      any : property value

  get_default_signed_attributes()
  get_impacted_process_list()

    Return a list containing the impacted process

    Returns:

      List[str] impacted process list

  get_localized_description(locale_code=None)

    locale_code is a 2 chars code like fr or en or de

  get_manifest_filename()
  get_signature_filename()
  get_software_version()

    Return the software version only (without the build number of the package)

    Returns:

      str: “software_version”

  get_stripped_package()

    Build a package keeping only Wapt stuff… Keeps only WAPT directory and setup.py

    Returns:

      bytes: zipped data

  get_values_for_db(locale_code)
  has_file(fname: str) → datetime

    Return None if fname is not in package, else return file datetime

    Args:

      fname (unicode): file path like WAPT/signature

    Returns:

      datetime : last modification datetime of file in Wapt archive if zipped or local sources if unzipped

  has_setup_py()
  inc_build()

    Increment last number part of version in memory

  invalidate_signature()

    Remove all signature informations from control and unzipped package directory Package must be in unzipped state.

  list_corrupted_files(ignore_missing_files=False, remove_extra_files=False)

    Check hexdigest sha for the files in manifest. Package must be already unzipped.

    Returns:

      list: non matching files (corrupted files)

  load_control_from_dict(adict)

    Fill in members of entry with keys from supplied dict

    adict members which are not a registered control attribute are set too and attribute name is put in list of “calculated” attributes.

    Args:

      adict (dict): key,value to put in this entry

    Returns:

      PackageEntry: self

  load_control_from_wapt(fname=None, calc_md5=False, keep_control_lines=False)

    Load package attributes from the control file (utf8 encoded) included in WAPT zipfile fname

    Args:
      fname (str or unicode): Package file/directory path

        If None, try to load entry attributes from self.sourcespath or self.localpath If fname is a file path, it must be Wapt zipped file, and try to load control data from it If fname is a directory path, it must be root dir of unzipped package file and load control from <fname>/WAPT/control

      calc_md5 (boolean): if True and fname is a zipped file, initialize md5sum attribute with md5 part of filename or calc from Zipped file

    Returns:

      PackageEntry: self

  local_attributes = ['sourcespath', 'repo', 'localpath', 'repo_url']
  make_fallback_uuid()
  make_package_edit_directory()

    Return the standard package directory to edit the package based on current attributes

    Returns:
      str: standard package filename

        - {package}_{version}_{architecture}_{OS}_{Min-OS-Version}_{Max-OS-Version}_{maturity}_{locale}-wapt

  make_package_filename(with_md5sum=False)

    Return the standard package filename based on current attributes parts of control which are either ‘all’ or empty are not included in filename

    Returns:
      str: standard package filename

        - packagename.wapt for host

        - packagename_arch_maturity_locale.wapt for group

        - packagename_version_arch_maturity_locale.wapt for others

  make_uuid()
  manifest_filename_excludes = ['WAPT/signature', 'WAPT/signature.sha256', 'WAPT/manifest.sha256']
  match(match_expr)

    Return True if package entry match a package string like ‘tis-package (>=1.0.1-00)

  match_search(search)

    Check if entry match search words

    Args:

      search (str): words to search for separated by spaces

    Returns:

      boolean: True if entry contains the words in search in correct order and at word boundaries

  match_version(version_expr)

    Return True if package entry match a version string condition like ‘>=1.0.1-00’

  matches_host_capabilities_string(capabilities)

    Return True if package is matching the host package raw capability string

  merge_stripped_package(stripped_package_zip_data=None, stripped_package_filename=None)

    Use the files from stripped_package_zip_data and include it in current unzipped package, remove files not in manifest, and recheck file hashes.

  not_duplicated_attributes = ['signer', 'signer_fingerprint', 'signature', 'signature_date', 'signed_attributes']
  optional_attributes = ['name', 'categories', 'maintainer', 'description', 'depends', 'conflicts', 'maturity', 'locale', 'target_os', 'min_wapt_version', 'sources', 'installed_size', 'impacted_process', 'description_fr', 'description_pl', 'description_de', 'description_es', 'description_pt', 'description_it', 'description_nl', 'description_ru', 'audit_schedule', 'editor', 'keywords', 'licence', 'homepage', 'package_uuid', 'valid_from', 'valid_until', 'forced_install_on', 'changelog', 'min_os_version', 'max_os_version', 'icon_sha256sum']
  package_certificates() → List[SSLCertificate]

    Return certificates from package. If package is built, take it from Zip else take the certificates from unzipped directory

    Returns:
      list: list of embedded certificates when package was signed or None if not provided or signed.

        First one of the list is the signer, the others are optional intermediate CA

  package_ident()

    Version independent package key

    Returns:

      tuple

  parse_capabilities_target_os(check=False)
  parse_version()

    Parse version to major, minor, patch, pre-release, build parts.

  remove_conflicts(to_remove)
  remove_depends(to_remove)
  repo_attributes = ['filename', 'size', 'md5sum']
  required_attributes = ['package', 'version', 'architecture', 'section', 'priority']
  save_control_to_wapt(fname=None, force=True)

    Save package attributes to the control file (utf8 encoded)

    Update self.locapath or self.sourcespath if not already set.

    Args:
      fname (str)base directoy of waptpackage or filepath of Zipped Packges.

        If None, use self.sourcespath if exists, or self.localpath if exists

      force (bool) : write control in wapt zip file even if it already exist

    Returns:

      PackageEntry : None if nothing written, or previous PackageEntry if new data written

    Raises:

      Exception: if fname is None and no sourcespath and no localpath Exception: if control exists and force is False

  set_icon_sha256sum()
  set_software_version(version, inc_build=False)

    Set the software version only inc_build will increment the buildnumber

  sign_package(certificate, private_key, keep_signature_date=False, excludes_full=['.svn', '.git', 'setup.pyc', 'update_package.pyc', '__pycache__/setup.cpython-39.pyc', '__pycache__/update_package.cpython-39.pyc'], excludes=[])

    Sign a package source directory or an already built (zipped) package. Should follow immediately the build_package step.

    Append signed control, manifest.sha256 and signature to zip wapt package If these files are already in the package, they are first removed.

    Use the self.localpath attribute to get location of waptfile build file.

    Args:

      certificate (SSLCertificate or list): signer certificate chain private_key (SSLPrivateKey): signer private key keep_signature_date (bool): If true, previous date fo signature is kept (useful when resigning is needed, but no meaningful change has been done) excludes_full (list) : list of exact (relative to package root) filepathes to exclude from manifest. excludes (list) : list of file / dir patterns to exclude, whatever level they are in the file hierarchy

    Returns:

      str: signature

  sign_stripped_package(certificate, private_key, excludes_full=['.svn', '.git', 'setup.pyc', 'update_package.pyc', '__pycache__/setup.cpython-39.pyc', '__pycache__/update_package.cpython-39.pyc'], excludes=[], sign_setuppy=False)

    Sign an unzipped source package assuming digests in manifest file are OK except for control and certificate.crt * remove signature files -> WAPT/certificate.crt, WAPT/signature.sha256, * resign WAPT/control * update control hash in WAPT/manifest.sha256 * resign WAPT/manifest.sha256 and put in WAPT/signature.sha256

    Args:

      certificate (list of SSLCertificate) : certificates chain of the signer. First certificate is the signer’s one. other are intermediate CA private_key (SSLPrivateKey) : key to sign the control and manifest files. excludes_full excludes

    Returns:

      str: signature of manifest.sha256

  signature_attributes = ['signer', 'signer_fingerprint', 'signature', 'signature_date', 'signed_attributes']
  sortable_version()
  property tags
  property target_os_list
  unzip_package(target_dir=None, cabundle=None, ignore_missing_files=False)

    Unzip package and optionnally check content

    Args:

      target_dir (str): where to unzip package content. If None, a temp dir is created cabundle (list) : list of Certificates to check content. If None, no check is done

    Returns:

      str : path to unzipped packages files

    Raises:

      EWaptNotAPackage, EWaptBadSignature,EWaptCorruptedFiles if check is not successful, unzipped files are deleted.

class waptpackage.PackageRequest(request=None, copy_from=None, **kwargs)

  Bases: `BaseObjectClass`

  Package and version request / condition The request is the basic packagename(=version) request Additional filters can be specified as arguments The list filters are ordered from most preferred to least preferred options

  Args:

    request (str): packagename(<=>version) architectures (list) : list of x64, x86, arm, arm64, armhf locales (list) : list of 2 letters lki

  property architectures

    List of accepted architecturs

  as_dict()
  fingerprint()
  get_package_compare_key(pe1: PackageEntry) → Tuple

    Compute a key for a package to compare it with other in the context of this request. This takes in account the preferences from filter like order of locale, architecture, or maturities which define preferences.

    Args:

      pe1 (PackageEntry)

    Returns:

      tuple

  is_matched_by(package_entry: PackageEntry, errors_list=None)

    Check if package_entry is matching this request

  property locales: List
  property maturities: List

    List of accepted maturities

  property max_os_version
  property min_os_version
  property package
  property request
  property tags: list

    List of accepted tags for OS

  property version

waptpackage.PackageVersion(package_or_versionstr) → Tuple

  Splits a version string 1.2.3.4-567 software version is clipped to 4 members if ‘-packaging’ is not provided, the second member will be 0 for safe comparison

  Args:

    package_or_versionstr (str): package version string

  Returns:

    tuple: (Version,int) : soft version on 4 members / packaging as an int

waptpackage.PackageVersionStr(package_or_versionstr) → Tuple

  Splits a version string 1.2.3.4-567 software version is clipped to 4 members if ‘-packaging’ is not provided, the second member will be 0 for safe comparison

  Args:

    package_or_versionstr (str): package version string

  Returns:

    tuple: (Version,int) : soft version on 4 members / packaging as an int

class waptpackage.WaptBaseRepo(name='abstract', cabundle: [<class 'waptcrypto.SSLCABundle'>, typing.Callable[[], waptcrypto.SSLCABundle]] = None, config=None, section=None)

  Bases: `BaseObjectClass`

  Base abstract class for a Wapt Packages repository

  as_dict() → dict
  property authorized_certificates: Sequence[dict]

    List of authorized signers certificates attributes

    Returns:

      list [dict]

  property cabundle: SSLCABundle
  config_fingerprint()
  get(packagename, default=None)
  get_certificates(packages_zipfile=None)

    Download signers certificates and crl from Package index on remote repository.

    > These certificates and CRL are appended to Packages index when scanning packages.

    Args:

      packages_zipfile (zipfile): if None, donwload it from repo

    Returns :

      SSLCABundle or None if Packages does not exists

  get_package_by_uuid(package_uuid: str) → PackageEntry
  get_package_entries(packages_names)

    Return most up to date packages entries for packages_names packages_names is either a list or a string Returns:

    > dict: a dictionnary with {‘packages’:[],’missing’:[]}

        >>> r = WaptRemoteRepo()
        >>> r.load_config_from_file('c:/wapt/wapt-get.ini')
        >>> res = r.get_package_entries(['tis-firefox','tis-putty'])
        >>> isinstance(res['missing'],list) and isinstance(res['packages'][0],PackageEntry)
        True

  invalidate_packages_cache()

    Reset in memory packages index Returns the old content of cached (packages, packages index date, discarded packages)

    Returns:

      dict : old cache status dict(_packages=self._packages,_packages_date=self._packages_date,discarded=self.discarded)

  is_available()

    Return isodate of last updates of the repo is available else None

  is_locally_allowed_package(package)

    Return True if package is not in blacklist and is in whitelist if whitelist is not None packages_whitelist and packages_blacklist are list of package name wildcards (file style wildcards) blacklist is taken in account first if defined. whitelist is taken in acoount if not None, else all not blacklisted package names are allowed.

  load_config(config=None, section=None)

    Load configuration from inifile section. Use name of repo as section name if section is not provided. Use ‘global’ if no section named section in ini file Value not defined in ini file are taken from class _default_config dict

    load_config is called at __init__, eventually with config = None. In this case, all parameters are initialized from defaults

    Args:

      config (RawConfigParser): ini configuration section (str) : section where to loads parameters

      > defaults to name of repository

    Returns:

      self: return itself to chain calls.

  load_config_from_file(config_filename, section=None)

    Load repository configuration from an inifile located at config_filename

    Args:

      config_filename (str) : path to wapt inifile section (str): ini section from which to get parameters. default to repo name

    Returns:

      WaptBaseRepo: self

  need_update(last_modified=None)

    Check if packages index has changed on repo and local index needs an update

    Compare date on local package index DB with the Packages file on remote

      repository with a HEAD http request.

    Args:

      last_modified (str): iso datetime of last known update of packages.

    Returns
      bool: True if either Packages was never read or remote date of Packages is

        more recent than the provided last_modifed date.

        >>> repo = WaptRemoteRepo(name='main',url='http://wapt/wapt',timeout=4)
        >>> waptdb = WaptDB('c:/wapt/db/waptdb.sqlite')
        >>> res = repo.need_update(waptdb.read_param('last-%s'% repo.url))
        >>> isinstance(res,bool)
        True

  packages()

    Return list of packages, load it from repository if not yet available in memory To force the reload, call invalidate_index_cache() first or update()

  packages_date()

    Date of last known packages index

    Returns:

      str: date/time of Packages index in iso format (string)

  packages_matching(package_cond: Optional[Union[str, PackageRequest]] = None, **kwargs) → list

    Return an ordered list of available packages entries which match the condition “packagename[([=<>]version)]?” version ascending

    Args:

      package_cond (str or PackageRequest): package name with optional version specifier.

    Returns:

      list of PackageEntry

        >>> from waptpackage import *
        >>> r = WaptRemoteRepo('http://wapt.tranquil.it/wapt')
        >>> r.packages_matching('tis-firefox(>=20)')
        [PackageEntry('tis-firefox','20.0.1-02'),
         PackageEntry('tis-firefox','21.0.0-00'),
         ...]

  property public_certs_dir: str
  property repo_url
  search(searchwords=[], sections=[], newest_only=False, exclude_sections=[], description_locale=None, host_capabilities=None, package_request=None, dependencies_list=[])
    Return list of package entries

      with description or name matching all the searchwords and section in provided sections list

    Args:

      searchwords (list or csv) : list of word to lookup in description and package names sections (list or csv) : list of package sections to use when searching newest_only (bool) : returns only highest version of package exclude_sections (list or csv): list of package sections to exclude when searching description_locale (str): if not None, search in description using this locale host_capabilities (HostCapabilities or dict): restrict output to these capabilities (os version locales, arch etc..) package_request (PackageRequest or dict) : restrict output to these filters, and sort output based on them

    Returns:

      list of PackageEntry with additional _localized_description added if description_locale is provided

        >>> r = WaptRemoteRepo(name='test',url='http://wapt.tranquil.it/wapt')
        >>> r.search('test')

  update()

    Update local index of packages from source index

    Returns:

      last packages update file date

class waptpackage.WaptLocalRepo(localpath=None, name='waptlocal', cabundle=None, config=None, section=None)

  Bases: `WaptBaseRepo`

  Index of Wapt local repository.
    Index of packages is located in a Packages zip file, having one

      Packages file, containing the concatenated content of “control” files of the packages.

      A blank line means new package.

      >>> localrepo = WaptLocalRepo('c:/wapt/cache')
      >>> localrepo.update()

  as_dict()
  is_available(url=None)

    Check if repo is reachable an return creation date of Packages.

    Returns:

      str: Iso creation date of remote Package file as returned in http headers

  load_config(config=None, section=None)

    Load waptrepo configuration from inifile section.

    > Use name of repo as section name if section is not provided. Use ‘global’ if no section named section in ini file

    Args:

      config (RawConfigParser): ini configuration section (str) : section where to loads parameters

      > defaults to name of repository

    Returns:

      WaptRemoteRepo: return itself to chain calls.

  property packages_path
  property repo_url
  update_packages_index(force_all=False, proxies=None, canonical_filenames=False, include_host_packages=False, include_certificates=True, include_crls=True, extract_icons=True)

    Scan self.localpath directory for WAPT packages and build a Packages (utf8) zip file with control data and MD5 hash

    Extract icons from packages (WAPT/icon.png) and stores them in <repo path>/icons/<package name>.png Extract certificate and add it to Packages zip file in ssl/<fingerprint.crt> Append CRL for certificates.

    Returns:

      dict : {‘processed’:processed,’kept’:kept,’errors’:errors,’packages_filename’:packages_fname}

class waptpackage.WaptRemoteRepo(url=None, name='', verify_cert=None, http_proxy=None, timeout=None, cabundle=None, config=None, section=None)

  Bases: `WaptBaseRepo`

  Gives access to a remote http repository, with a zipped Packages packages index

      >>> repo = WaptRemoteRepo(name='main',url='http://wapt/wapt',timeout=4)
      >>> last_modified = repo.is_available()
      >>> isinstance(last_modified,str)
      True

  as_dict()

    returns a dict representation of the repository configuration and parameters

  client_auth()

    Return SSL trio filenames for client side SSL auth

    Returns:

      tuple: (cert filename,key filename,key pwd)

  download_icons(packages_icon_sha256sum, target_dir=None)

    Download a list of icons from packages (requests are of the form packagename (>version) ) returns a dict of {“downloaded,”skipped”,”errors”}

    Args:

      packages_icon_sha256sum (list) : list of dict {‘package’,’icon_sha256sum’}

    Returns:

      dict: ‘packages’, ‘downloaded’, ‘skipped’, ‘errors’

  download_packages(package_requests, target_dir=None, usecache=True, printhook=None)
    Download a list of packages (requests are of the form packagename (>version) )

      returns a dict of {“downloaded,”skipped”,”errors”}

    If package_requests is a list of PackageEntry, update localpath of entry to match downloaded file.

    Args:

      package_requests (list) : list of PackageEntry to download or list of package with optional version

    Returns:

      dict: ‘packages’, ‘downloaded’, ‘skipped’, ‘errors’

        >>> repo = WaptRemoteRepo(url='http://wapt.tranquil.it/wapt')
        >>> wapt.download_packages(['tis-firefox','tis-waptdev'],printhook=nullhook)
        {'downloaded': [u'c:/wapt\\cache\\tis-firefox_37.0.2-9_all.wapt', u'c:/wapt\\cache\\tis-waptdev.wapt'], 'skipped': [], 'errors': []}

  get_private_key_password(location, identity)
  get_requests_session(url=None, http_proxy=None)

    Returns a requests session object with optional ssl client side auth and proxies

    Returns:

      requests.Session

  is_available(url=None, http_proxy=None)

    Check if repo is reachable an return creation date of Packages.

    Try to access the repo and return last modified date of repo index or None if not accessible

    Returns:

      str: Iso creation date of remote Package file as returned in http headers

        >>> repo = WaptRemoteRepo(name='main',url='https://wapt/wapt',timeout=1)
        >>> repo.is_available() <= datetime2isodate()
        True
        >>> repo = WaptRemoteRepo(name='main',url='https://badwapt/wapt',timeout=1)
        >>> repo.is_available() is None
        True

  load_config(config=None, section=None)

    Load waptrepo configuration from inifile section.

    Use name of repo as section name if section is not provided.

    Use ‘global’ if no section named section in ini file

    Args:

      config (RawConfigParser): ini configuration section (str) : section where to loads parameters

      > defaults to name of repository

    Returns:

      WaptRemoteRepo: return itself for chain calls.

  packages_url(url=None)

    return url of Packages index file

        >>> repo = WaptRemoteRepo(name='main',url='http://wapt/wapt',timeout=4)
        >>> repo.packages_url
        'http://wapt/wapt/Packages'

    hardcoded path to the Packages index.

  property proxies

    dict for http proxies url suitable for requests based on the http_proxy repo attribute

    Returns:

      dict: {‘http’:’http://proxy:port’,’https’:’http://proxy:port’}

  property repo_url

waptpackage.control_to_dict(control, int_params=('size', 'installed_size'), out_excluded_control_keys=['filename', 'size', 'md5sum', 'repo_url', 'repo'], out_control_lines=None)

  Convert a control file like object key1: value1 key2: value2 … list of lines into a dict

  Multilines strings begins with a space

  Breaks when an empty line is reached (limit between 2 package in Packages indexes)

  Args:

    control (file,str or list): file like object to read control from (until an empty line is reached) int_params (list): attributes which must be converted to int out_control_lines (list): if not None, decoded raw control lines are appended to this list.

  Returns:

    dict

waptpackage.make_version(major_minor_patch_build)

waptpackage.parse_major_minor_patch_build(version)

  Parse version to major, minor, patch, pre-release, build parts.

waptpackage.update_packages(adir, force=False, proxies=None, canonical_filenames=False)

  Helper function to update a local packages index

  This function is used on repositories to rescan all packages and

    update the Packages index.

      >>> if os.path.isdir('c:\wapt\cache'):
      ...     repopath = 'c:\wapt\cache'
      ... else:
      ...     repopath = '/var/www/wapt'
      >>> p = PackageEntry()
      >>> p.package = 'test'
      >>> p.version = '10'
      >>> new_package_fn = os.path.join(repopath,p.make_package_filename())
      >>> if os.path.isfile(new_package_fn):
      ...     os.unlink(new_package_fn)
      >>> res = update_packages(repopath)
      >>> os.path.isfile(res['packages_filename'])
      True
      >>> r = WaptLocalRepo(localpath=repopath)
      >>> l1 = r.packages()
      >>> res = r.update_packages_index()
      >>> l2 = r.packages()
      >>> [p for p in l2 if p not in l1]
      ["test (=10)"]

# Common

exception common.EWaptBadServerAuthentication

  Bases: `EWaptException`

exception common.EWaptCancelled

  Bases: `Exception`

class common.Wapt(config_filename=None, defaults=None, disable_update_server_status=True, wapt_base_dir=None, dbpath=None, publicdbpath=None, merge_config_packages=None)

  Bases: `BaseObjectClass`

  Global WAPT engine

  add_hosts_repo() → WaptHostRepo

    Add an automatic host repository, remove existing WaptHostRepo last one before

  add_pyscripter_project(target_directory)

    Add a pyscripter project file to package development directory.

    Args:

      target_directory (str): path to location where to create the wapt.psproj file.

    Returns:

      None

  add_upgrade_shutdown_policy()

    Add a local shitdown policy to upgrade system

  add_vscode_project(target_directory)

    Add .vscode folder with project files to the package development directory

    Args:

      target_directory (str): path to the package development directory.

    Returns:

      None

  as_dict()
  audit(package, force=False, ignore_schedule=False, audited_by=None) → str

    Run the audit hook for the installed package” Source setup.py from database, filename, or packageEntry Stores the result and log into “wapt_localstatus” table

    Args:

      package (PackageEntry or directory or package name or {package_uuid} ): package to audit

    Returns:

      str : iso datetime of this audit as stored in packages status table

  audit_data_expired(section, key, value)

    Check if the latest value associated with section/key is expired

    Returns:

      bool: True is data exists and has expires or if data does not exists.

  authorized_certificates()

    return a list of autorized package certificate issuers for this host check_certificates_validity enable date checking.

  available_categories()
  build_update_status_data(force=False, excluded_keys=[]) → dict
  property cabundle: SSLCABundle
  call_python_code(python_filename, func_name, package_entry=None, force=None, params=None, working_dir=None, import_modules=[])

    Calls a function in python_filename. Set basedir, control, and run context within the function context.

    Args:

      python_filename : python filename mith module to load. func_name (str): name of function to call in setuppy package_entry (PackageEntry): if not None, use it to set environment

    Returns:

      output of hook.

  check_all_depends_conflicts()

    Check the whole dependencies/conflicts tree for installed packages

  check_cancelled(msg='Task cancelled')
  check_depends(apackages, forceupgrade=False, force=False, assume_removed=[], package_request_filter=None)

    Given a list of packagename or requirement “name(=version)”, return a dictionnary of {‘additional’ ‘upgrade’ ‘install’ ‘skipped’ ‘unavailable’,’remove’} of [packagerequest,matching PackageEntry]

    Args:

      apackages (str or list): list of packages for which to check missing dependencies. forceupgrade (boolean): if True, check if the current installed packages is the latest available force (boolean): if True, install the latest version even if the package is already there and match the requirement assume_removed (list): list of packagename which are assumed to be absent even if they are actually installed to check the

      > consequences of removal of packages, implies force=True

      package_request_filter (PackageRequest): additional filter to apply to packages to sort by locales/arch/mat preferences

        if None, get active host filter

    Returns:

      dict : {‘additional’ ‘upgrade’ ‘install’ ‘skipped’ ‘unavailable’, ‘remove’} with list of [packagerequest,matching PackageEntry]

  check_downloads(apackages=None, usecache=True)

    Return list of available package entries to match supplied packages requirements

    Args:

      apackages (list or str): list of packages usecache (bool) : returns only PackageEntry not yet in cache

    Returns:

      list: list of PackageEntry to download

  check_install(apackages=None, force=True, forceupgrade=True) → Dict[str, List[Tuple]]

    Return a list of actions required for install of apackages list of packages if apackages is None, check for all pending updates.

    Args:

      apackages (str or list): list of packages or None to check pending install/upgrades force (boolean): if True, already installed package listed in apackages

      > will be considered to be reinstalled

      forceupgrade: if True, all dependencies are upgraded to latest version,

        even if current version comply with depends requirements

    Returns:
      dict: with keys [‘skipped’, ‘additional’, ‘remove’, ‘upgrade’, ‘install’, ‘unavailable’] and list of

        (package requirements, PackageEntry)

  check_install_running(max_ttl=60)

    Check if an install is in progress, return list of pids of install in progress Kill old stucked wapt-get processes/children and update db status max_ttl is maximum age of wapt-get in minutes

  check_peercache_status()
  check_remove(apackages)

    Return a list of additional package to remove if apackages are removed

    Args:

      apackages (str or list of req or PackageRequest): list of packages for which parent dependencies will be checked.

    Returns:

      list: list of PackageRequest with broken dependencies

  cleanup(obsolete_only=False)

    Remove cached WAPT files from local disk

    Args:
      obsolete_only (boolean): If True, remove packages which are either no more available,

        or installed at a equal or newer version

    Returns:

      list: list of filenames of removed packages

        >>> wapt = Wapt(config_filename='c:/wapt/wapt-get.ini')
        >>> l = wapt.download_packages(wapt.check_downloads())
        >>> res = wapt.cleanup(True)

  cleanup_session_setup() → int

    Remove all current user session_setup informations for removed packages

  config_overview()
  config_parser()
  create_or_update_host_certificate(force_recreate=False)
    Create a rsa key pair for the host and a x509 certiticate.

      Location of key is <wapt_root>private Should be kept secret restricted access to system account and administrators only.

    Args:

      force_recreate (bool): recreate key pair even if already exists for this FQDN.

    Returns:

      str: x509 certificate of this host.

  property dbpath
  default_config_filename()
  delete_audit_data(section: str, key: str)

    Remove all audit data related to a section and key Args:

    > section (str): key (str): can be a sql like clause (ie can include ? and % for wildcard)

  delete_param(name, public=True)

    Remove a key from local db

  dependencies(packagename, expand=False)

    Return all dependecies of a given package >>> w = Wapt(config_filename=’c:/wapt/wapt-get.ini’) >>> dep = w.dependencies(‘tis-waptdev’) >>> isinstance(dep,list) and isinstance(dep[0],PackageEntry) True

  download_icons(package_requests, usecache=True, printhook=None)

    Download a list of package icons (requests are of the form packagename (>version) ) returns a dict of {“downloaded,”skipped”,”errors”}

    Args:

      package_requests (str or list): list of packages to prefetch usecache (boolean) : if True, don’t download package if already in cache printhook (func) : callback with signature report(received,total,speed,url) to display progress

    Returns:

      dict: with keys {“downloaded,”skipped”,”errors”,”packages”} and list of PackageEntry.

        >>> wapt = Wapt(config_filename='c:/wapt/wapt-get.ini')
        >>> def nullhook(*args):
        ...     pass
        >>> wapt.download_packages(['tis-firefox','tis-waptdev'],usecache=False,printhook=nullhook)
        {'downloaded': [u'c:/wapt\\cache\\tis-firefox_37.0.2-9_all.wapt', u'c:/wapt\\cache\\tis-waptdev.wapt'], 'skipped': [], 'errors': []}

  download_packages(package_requests=typing.List[str], usecache=True, printhook=None)

    Download a list of packages (requests are of the form packagename(=version) ) If several packages are matching a request, the highest/latest only is kept.

    Args:

      package_requests (str or list): list of packages to prefetch usecache (boolean) : if True, don’t download package if already in cache printhook (func) : callback with signature report(received,total,speed,url) to display progress

    Returns:

      dict: with keys {“downloaded,”skipped”,”errors”,”packages”} and list of PackageEntry.

        >>> wapt = Wapt(config_filename='c:/wapt/wapt-get.ini')
        >>> def nullhook(*args):
        ...     pass
        >>> wapt.download_packages(['tis-firefox','tis-waptdev'],usecache=False,printhook=nullhook)
        {'downloaded': [u'c:/wapt\\cache\\tis-firefox_37.0.2-9_all.wapt', u'c:/wapt\\cache\\tis-waptdev.wapt'], 'skipped': [], 'errors': []}

  download_upgrades()

    Download packages that can be upgraded

  duplicate_package(packagename, newname=None, newversion=None, newmaturity=None, target_directory=None, append_depends=None, remove_depends=None, append_conflicts=None, remove_conflicts=None, auto_inc_version=True, usecache=True, printhook=None, cabundle=None)

    Duplicate an existing package. Duplicate an existing package from declared repostory or file into targetdirectory with

    > optional newname and version.

    Args:

      packagename (str) : packagename to duplicate, or filepath to a local package or package development directory. newname (str): name of target package newversion (str): version of target package. if None, use source package version target_directory (str): path where to put development files. If None, use temporary. If empty, use default development dir append_depends (list): comma str or list of depends to append. remove_depends (list): comma str or list of depends to remove. auto_inc_version (bool): if version is less than existing package in repo, set version to repo version+1 usecache (bool): If True, allow to use cached package in local repo instead of downloading it. printhook (func): hook for download progress cabundle (SSLCABundle): list of authorized ca certificate (SSLPublicCertificate) to check authenticity of source packages. If None, no check is performed.

    Returns:

      PackageEntry : new packageEntry with sourcespath = target_directory

        >>> wapt = Wapt(config_filename='c:/tranquilit/wapt/tests/wapt-get.ini')
        >>> wapt.dbpath = ':memory:'
        >>> r= wapt.update()
        >>> def nullhook(*args):
        ...     pass
        >>> tmpdir = 'c:/tmp/testdup-wapt'
        >>> if os.path.isdir(tmpdir):
        ...     import shutil
        ...     shutil.rmtree(tmpdir)
        >>> p = wapt.duplicate_package('tis-wapttest',
        ...     newname='testdup',
        ...     newversion='20.0-0',
        ...     target_directory=tmpdir,
        ...     excludes=['.svn','.git','.gitignore','*.pyc','src'],
        ...     append_depends=None,
        ...     auto_inc_version=True,
        ...     usecache=False,
        ...     printhook=nullhook)
        >>> print repr(p['package'])
        PackageEntry('testdup','20.0-0')
        >>> if os.path.isdir(tmpdir):
        ...     import shutil
        ...     shutil.rmtree(tmpdir)
        >>> p = wapt.duplicate_package('tis-wapttest',
        ...    target_directory=tempfile.mkdtemp('wapt'),
        ...    auto_inc_version=True,
        ...    append_depends=['tis-firefox','tis-irfanview'],
        ...    remove_depends=['tis-wapttestsub'],
        ...    )
        >>> print repr(p['package'])
        PackageEntry('tis-wapttest','120')

  edit_host(hostname, target_directory=None, append_depends=None, remove_depends=None, append_conflicts=None, remove_conflicts=None, printhook=None, description=None, cabundle=None)

    Download and extract a host package from host repositories into target_directory for modification

    Args:

      hostname (str) : fqdn of the host to edit target_directory (str) : where to place the developments files. if empty, use default one from wapt-get.ini configuration append_depends (str or list) : list or comma separated list of package requirements remove_depends (str or list) : list or comma separated list of package requirements to remove cabundle (SSLCA Bundle) : authorized ca certificates. If None, use default from current wapt.

    Returns:

      PackageEntry

        >>> wapt = Wapt(config_filename='c:/wapt/wapt-get.ini')
        >>> tmpdir = 'c:/tmp/dummy'
        >>> wapt.edit_host('dummy.tranquilit.local',target_directory=tmpdir,append_depends='tis-firefox')
        >>> import shutil
        >>> shutil.rmtree(tmpdir)
        >>> host = wapt.edit_host('htlaptop.tranquilit.local',target_directory=tmpdir,append_depends='tis-firefox')
        >>> 'package' in host
        True
        >>> shutil.rmtree(tmpdir)

  edit_package(packagerequest, target_directory='', use_local_sources=True, append_depends=None, remove_depends=None, append_conflicts=None, remove_conflicts=None, auto_inc_version=True, cabundle=None)

    Download an existing package from repositories into target_directory for modification if use_local_sources is True and no newer package exists on repos, updates current local edited data else if target_directory exists and is not empty, raise an exception

    Args:

      packagerequest (str) : path to existing wapt file, or package request use_local_sources (boolean) : don’t raise an exception if target exist and match package version append_depends (list of str) : package requirements to add to depends remove_depends (list or str) : package requirements to remove from depends auto_inc_version (bool) : cabundle (SSLCABundle) : list of authorized certificate filenames. If None, use default from current wapt.

    Returns:

      PackageEntry : edit local package with sourcespath attribute populated

        >>> wapt = Wapt(config_filename='c:/tranquilit/wapt/tests/wapt-get.ini')
        >>> wapt.dbpath = ':memory:'
        >>> r= wapt.update()
        >>> tmpdir = tempfile.mkdtemp('wapt')
        >>> res = wapt.edit_package('tis-wapttest',target_directory=tmpdir,append_depends='tis-firefox',remove_depends='tis-7zip')
        >>> res['target'] == tmpdir and res['package'].package == 'tis-wapttest' and 'tis-firefox' in res['package'].depends
        True
        >>> import shutil
        >>> shutil.rmtree(tmpdir)

  error_packages()

    return install tasks with error status

  forget_packages(packages_list)

    Remove install status for packages from local database without actually uninstalling the packages

    Args:

      packages_list (list): list of installed package names to forget

    Returns:

      list: list of package names actually forgotten

        >>> wapt = Wapt(config_filename='c:/wapt/wapt-get.ini')
        >>> res = wapt.install('tis-test')
        ???
        >>> res = wapt.is_installed('tis-test')
        >>> isinstance(res,PackageEntry)
        True
        >>> wapt.forget_packages('tis-test')
        ['tis-test']
        >>> wapt.is_installed('tis-test')
        >>> print wapt.is_installed('tis-test')
        None

  generate_host_uuid()

    Regenerate a random UUID for this host or force with supplied one.

    Normally, the UUID is taken from BIOS through wmi.

    In case bios returns some duplicates or garbage, it can be useful to force a random uuid. This is stored as uuid key in local agent database only.

    In case we want to link th host with a an existing record on server, we can force a old UUID.

  get_cabundle() → SSLCABundle
  get_cache_domain_info(force=False)
  get_cached_packages_uuids()
  get_config_files_list()
  get_config_hash()
  get_default_development_dir(packagecond: str, section='base') → str

    Returns the default development directory for package named <packagecond> based on default_sources_root ini parameter if provided

    Args:

      packagecond (PackageEntry or str): either PackageEntry or a “name(=version)” string

    Returns:

      unicode: path to local proposed development directory

  get_hardware_uuid()

    Return ‘’ if no hardware uuid can be found

  get_host_certificate()

    Return the current host certificate. If the certificate does not yet exist, it is created as a self signed certificate and stored in get_host_certificate_filename path

    Returns:

      SSLCertificate: host public certificate.

  get_host_certificate_authority_key_identifier()
  get_host_certificate_filename()

    Full filepath of the host own certificate and RSA public key

    Returns:

      str

  get_host_certificate_fingerprint()
  get_host_certificate_signing_request()

    Return a CSR with CN and AltSubjectNames pointing to this host uuid

    Returns:

      SSLCertificateSigningRequest: host public certificate sigbinbg request.

  get_host_key(create=True)

    Return private key used to sign uploaded data from host Create key if it does not exists yet.

    Returns:

      SSLPrivateKey: Private key used to sign data posted by host.

  get_host_key_filename()

    Full filepath of the host own RSA private key

    Returns:

      str

  get_host_locales()
  get_host_packages()

    Return list of implicit available host packages based on computer UUID and AD Org Units

    Returns:

      list: list of PackageEntry.

  get_host_packages_names()

    Return list of implicit host package names based on computer UUID and AD Org Units

    Returns:

      list: list of str package names.

  get_host_site()
  get_installed_host_packages()

    Get the implicit package names (host and unit packages) which are installed but no longer relevant

    Returns:

      list: of installed package names

  get_installer_defaults(installer_path) → Dict

    Returns guessed default values for package templates based on installer binary

    Args:

      installer_path (str): filepath to installer

    Returns:

      dict:

        >>> get_installer_defaults(r'c: ranquilit\wapt  ests\SumatraPDF-3.1.1-install.exe')
        {'description': u'SumatraPDF Installer (Krzysztof Kowalczyk)',
        'filename': 'SumatraPDF-3.1.1-install.exe',
        'silentflags': '/VERYSILENT',
        'simplename': u'sumatrapdf-installer',
        'type': 'UnknownExeInstaller',
        'version': u'3.1.1'}

        >>> get_installer_defaults(r'c: ranquilit\wapt  estsz920.msi')
        {'description': u'7-Zip 9.20 (Igor Pavlov)',
        'filename': '7z920.msi',
        'silentflags': '/q /norestart',
        'simplename': u'7-zip-9.20',
        'type': 'MSI',
        'version': u'9.20.00.0'}

  get_json_config_certificates_filenames(config_name)
  get_json_config_filename(config_name)

    Returns the filename for a json config named <config_name>

  get_last_update_status()

    Get update status of host as stored at the end of last operation.

    Returns:
      dict:

        ‘date’: timestamp of last operation ‘runstatus’: last printed message of wapt core ‘running_tasks’: list of tasks ‘errors’: list of packages not installed properly ‘upgrades’: list of packages which need to be upgraded

  get_next_audit_datetime()

    Return next datetime for next audit loop = minimum(next_audit_date)

  get_outdated_host_packages()

    Check and return the available host packages available and not installed

  get_package_attribute(package, key, default_value=None, public=False)

    Store in local db a key/value pair for later use

  get_package_entries(packages_names)

    Return most up to date packages entries for packages_names packages_names is either a list or a string.

    ‘missing’ key lists the package requirements which are not available in the package index.

    Args;

      packages_names (list or str): list of package requirements

    Returns:

      dict : {‘packages’:[PackageEntries,],’missing’:[str,]}

        >>> wapt = Wapt(config_filename='c:/wapt/wapt-get.ini')
        >>> res = wapt.get_package_entries(['tis-firefox','tis-putty'])
        >>> isinstance(res['missing'],list) and isinstance(res['packages'][0],PackageEntry)
        True

  get_previous_package_params(package_entry)

    Return the params used when previous install of package_entry.package If no previous install, return {} The params are stored as json string in local package status table.

    Args:

      package_entry (PackageEntry): package request to lookup.

    Returns:

      dict

  get_repo(repo_name) → WaptRemoteRepo
  get_secured_token_generator(token_secret_key)
  get_sources(package)

    Download sources of package (if referenced in package as a https svn) in the current directory

    Args:

      package (str or PackageRequest): package to get sources for

    Returns:

      str : checkout directory path

  get_token_secret_key() → str
  get_unrelevant_host_packages()

    Get the implicit package names (host and unit packages) which are installed but no longer relevant

    Returns:

      list: of installed package names

  get_wapt_edition()
  global_attributes = ['wapt_base_dir', 'waptserver', 'config_filename', 'proxies', 'repositories', 'personal_certificate_path', 'public_certs_dir', 'packages_cache_dir', 'dbpath', 'publicdbpath', 'http_proxy', 'use_http_proxy_for_repo', 'use_http_proxy_for_server', 'limit_bandwidth', 'waptservice_admin_filter', 'waptservice_port', 'waptservice_poll_timeout', 'locales', 'custom_tags', 'packages_default_allow', 'packages_whitelist', 'packages_blacklist', 'maturities', 'host_uuid', 'use_fqdn_as_uuid', 'use_hostpackages', 'use_ad_groups', 'use_repo_rules', 'ad_groups_use_nested_group', 'host_profiles', 'host_organizational_unit_dn', 'host_ad_site', 'allow_user_service_restart', 'allow_remote_shutdown', 'allow_remote_reboot', 'ldap_auth_server', 'ldap_auth_base_dn', 'loglevel', 'loglevel_waptcore', 'loglevel_waptservice', 'loglevel_wapttasks', 'loglevel_waptws', 'loglevel_waptdb', 'loglevel_websocket', 'loglevel_waitress', 'log_to_windows_events', 'download_after_update_with_waptupdate_task_period', 'websockets_ping', 'websockets_retry_delay', 'websockets_check_config_interval', 'websockets_hurry_interval', 'notify_user', 'waptaudit_task_period', 'signature_clockskew', 'wol_relay', 'hiberboot_enabled', 'max_gpo_script_wait', 'pre_shutdown_timeout', 'minimum_battery_percent', 'uninstallkey_timeout', 'check_certificates_validity', 'token_lifetime', 'repositories', 'trust_all_certs_in_pems', 'wapt_temp_dir', 'peercache_enable', 'check_rules_signature']
  property hiberboot_enabled

    get HiberbootEnabled.

  host_capabilities()

    Return the current capabilities of host taken in account to determine packages list and whether update should be forced (when filter criteria are updated) This includes host certificate,architecture,locale,authorized certificates

    Returns:

      dict

  host_capabilities_fingerprint()

    Return a fingerprint representing the current capabilities of host This includes host certificate,architecture,locale,authorized certificates

    Returns:

      str

  property host_dn
  property host_organizational_unit_dn

    Get host org unit DN from wapt-get.ini [global] host_organizational_unit_dn if defined or from registry as supplied by AD / GPO process

  host_packagename()

    Return package name for current computer

  property host_profiles
  property host_site
  property host_uuid: str
  inc_status_revision(inc=1) → int
  init_waptwua(loglevel_waptwua=None)

    Init waptwua submodule with current Wapt settings, and apply settings to current host Update registry policies to match waptwua settings Start/Stop/Disable wuauserv windows service accordingly

  install(apackages=typing.List[str], force=False, params_dict={}, download_only=False, usecache=True, printhook=None, installed_by=None, only_priorities=None, only_if_not_process_running=False, process_dependencies=True, raise_exception_if_errors_or_unavailable=True)

    Install a list of packages and its dependencies removes first packages which are in conflicts package attribute

    Returns a dictionary of (package requirement,package) with ‘install’,’skipped’,’additional’,’unavailable’

    Args:

      apackages (list or str): list of packages requirements “packagename(=version)” or list of PackageEntry. force (bool) : reinstalls the packages even if it is already installed params_dict (dict) : parameters passed to the install() procedure in the packages setup.py of all packages

      > as params variables and as “setup module” attributes

      download_only (bool) : don’t install package, but only download them usecache (bool) : use the already downloaded packages if available in cache directory printhook (func) : hook for progress print

    Returns:
      dict: with keys [‘skipped’, ‘additional’, ‘remove’, ‘upgrade’, ‘install’, ‘unavailable’] and list of

        (package requirements, PackageEntry)

        >>> wapt = Wapt(config_filename='c:/tranquilit/wapt/tests/wapt-get.ini')
        >>> def nullhook(*args):
        ...     pass
        >>> res = wapt.install(['tis-wapttest'],usecache=False,printhook=nullhook,params_dict=dict(company='toto'))
        >>> isinstance(res['upgrade'],list) and isinstance(res['errors'],list) and isinstance(res['additional'],list) and isinstance(res['install'],list) and isinstance(res['unavailable'],list)
        True
        >>> res = wapt.remove('tis-wapttest')
        >>> res == {'removed': ['tis-wapttest'], 'errors': []}
        True

  install_immediate(force=False, only_priorities=None, only_if_not_process_running=False)

    Install pending packages which must be forcibly installed at a specific time.

    Args:

      only_if_not_process_running: install package only if impacted_process are not running

    Returns:
      dict: {‘upgrade’: [], ‘additional’: [], ‘downloads’:

        > {‘downloaded’: [], ‘skipped’: [], ‘errors’: []},

        ‘remove’: [], ‘skipped’: [], ‘install’: [], ‘errors’: [], ‘unavailable’: []}

  install_json_config(conf: dict, config_name: Optional[str] = None, priority=None) → Tuple[bool, str]

    Add a dynamic configuration from dict conf with name config_name and priority

    - Removes existing json config and associated certificates

    - Extracts packages certificates and server certificates in <wapt>/ssl/ and<wapt>/ssl/server/

    - Writes json config in <wapt>/conf.d/<config_name>.json

    Args:

      conf (dict): json config with optional ‘name’ and ‘priority’ keys config_name (str): name of config. Will be the name of json file in conf.d.

      > used to prefix the certificates names

    Returns:

      Tuple(installed, path to json)

  install_json_config_file(json_config_file, config_name=None, priority=None) → Tuple[bool, str]

    Install a json config stored in a file

    Returns:

      Tuple(installed, path to json)

  install_json_config_from_url(url=None, config_hash=None, config_name='default_config', priority=None)

    Load a json config from the remote wapt server (default location is /var/www/wapt/conf.d/<config_name>-<config_hash>.json) given its name and hash.

  install_json_configb64(json_config_b64, config_name=None, priority=None)

    Install a json config encoded as a base64 string

  install_wapt(fname, params_dict={}, explicit_by=None, force=None)

    Install a single wapt package given its WAPT filename. return install status

    Args:

      fname (str): Path to wapt Zip file or unzipped development directory params (dict): custom parameters for the install function explicit_by (str): identify who has initiated the install

    Returns:

      str: ‘OK’,’ERROR’

    Raises:

    > EWaptMissingCertificate EWaptNeedsNewerAgent EWaptUnavailablePackage EWaptConflictingPackage EWaptBadPackageAttribute EWaptException various Exception depending on setup script

  installed(include_errors=False) → List[PackageEntry]

    Returns all installed packages with their status

    Args:

      include_errors (boolean): include packages wnot installed successfully

    Returns:

      list: list of PackageEntry merged with local install status.

  installed_package_names(include_errors=False)

    Private list of installed packages

  inventory()

    Return full inventory of the computer as a dictionary.

    Returns:

      dict: {‘host_info’,’wapt_status’,’installed_softwares’,’installed_packages’}

    …changed:

      1.4.1: renamed keys 1.6.2.4: removed setup.py from packages inventory.

  is_authorized_package_action(action, package_cond, user_groups=[], rules=None)
  is_available(packagename) → List[PackageEntry]

    Check if a package (with optional version condition) is available in repositories.

    Args:

      packagename (str) : package name to lookup or package requirement ( packagename(=version) )

    Returns:

      list : of PackageEntry sorted by package version ascending

        >>> wapt = Wapt(config_filename='c:/tranquilit/wapt/tests/wapt-get.ini')
        >>> l = wapt.is_available('tis-wapttest')
        >>> l and isinstance(l[0],PackageEntry)
        True

  is_enterprise() → bool
  is_installed(packagename: str, include_errors=False) → PackageEntry

    Checks if a package is installed. Return package entry and additional local status or None

    Args:

      packagename (str): name / {package_uuid}/ package request to query

    Returns:
      PackageEntry: None or PackageEntry merged with local install_xxx fields

        - install_date

        - install_output

        - install_params

        - install_status

  is_locally_allowed_package(package)

    Return True if package is not in blacklist and is in whitelist if whitelist is not None packages_whitelist and packages_blacklist are list of package name wildcards (file style wildcards) blacklist is taken in account first if defined. whitelist is taken in acoount if not None, else all not blacklisted package names are allowed.

  is_wapt_package_development_dir(directory)

    Return PackageEntry if directory is a wapt developement directory (a WAPT/control file exists) or False

  is_wapt_package_file(filename)

    Return PackageEntry if filename is a wapt package or False True if file ends with .wapt and control file can be loaded and decoded from zip file

    Args:

      filename (str): path to a file

    Returns:

      False or PackageEntry

  last_install_log(packagename)

    Get the printed output of the last install of package named packagename

    Args:

      packagename (str): name of package to query

    Returns:

      dict: {status,log} of the last install of a package

        >>> w = Wapt()
        >>> w.last_install_log('tis-7zip')
        ???
        {'install_status': u'OK', 'install_output': u'Installing 7-Zip 9.38.0-1\n7-Zip already installed, skipping msi install\n',install_params: ''}

  list(searchwords=[])

    Returns a list of installed packages which have the searchwords in their description

    Args:
      searchwords (list): list of words to llokup in package name and description

        only entries which have words in the proper order are returned.

    Returns:

      list: list of PackageEntry matching the search words

        >>> w = Wapt()
        >>> w.list('zip')
        [PackageEntry('tis-7zip','16.4-8') ]

  list_config_attributes = ['host_profiles', 'maturities', 'custom_tags', 'packages_whitelist', 'packages_blacklist', 'locales', 'repositories']
  list_upgrade(current_datetime=None)

    Returns a list of package requirements for packages which should be installed / upgraded / removed

    Returns:

      dict: {‘additional’: [], ‘install’: [], ‘remove’: [], ‘upgrade’: []}

  load_config(config_filename=None, merge_config_packages=None)

    Load configuration parameters from supplied inifilename

  make_group_template(packagename='', maturity=None, depends=None, conflicts=None, directoryname=None, section='group', description=None) → PackageEntry

    Creates or updates on disk a skeleton of a WAPT group package. If the a package skeleton already exists in directoryname, it is updated.

    sourcespath attribute of returned PackageEntry is populated with the developement directory of group package.

    Args:

      packagename (str): group name depends : conflicts directoryname section description

    Returns:

      PackageEntry

        >>> wapt = Wapt(config_filename='c:/wapt/wapt-get.ini')
        >>> tmpdir = 'c:/tmp/dummy'
        >>> if os.path.isdir(tmpdir):
        ...    import shutil
        ...    shutil.rmtree(tmpdir)
        >>> p = wapt.make_group_template(packagename='testgroupe',directoryname=tmpdir,depends='tis-firefox',description=u'Test de groupe')
        >>> print p
        >>> print p['package'].depends
        tis-firefox
        >>> import shutil
        >>> shutil.rmtree(tmpdir)

  make_host_template(packagename='', depends=None, conflicts=None, directoryname=None, description=None) → PackageEntry
  make_package_template(installer_path='', packagename='', directoryname='', section='base', description=None, depends='', version=None, silentflags=None, uninstallkey=None, maturity=None, architecture='all', target_os='all', product_name=None) → str
    Build a skeleton of WAPT package based on the properties of the supplied installer

      Return the path of the skeleton

        >>> wapt = Wapt(config_filename='c:/wapt/wapt-get.ini')
        >>> wapt.dbpath = ':memory:'
        >>> files = 'c:/tmp/files'
        >>> if not os.path.isdir(files):
        ...    os.makedirs(files)
        >>> tmpdir = 'c:/tmp/dummy'
        >>> devdir = wapt.make_package_template(files,packagename='mydummy',directoryname=tmpdir,depends='tis-firefox')
        >>> os.path.isfile(os.path.join(devdir,'WAPT','control'))
        True
        >>> p = wapt.build_package(devdir)
        >>> 'filename' in p and isinstance(p['files'],list) and isinstance(p['package'],PackageEntry)
        True
        >>> import shutil
        >>> shutil.rmtree(tmpdir)

  property max_gpo_script_wait

    get / set the MaxGPOScriptWait.

  merge_installed_softwares_and_wua_list()
  property merged_config_hash: str
  network_reconfigure()

    Called whenever the network configuration has changed

  packages_filter_for_host()

    Returns a PackageRequest object based on host capabilities to filter applicable packages from a repo

    Returns:

      PackageRequest

  packages_matching(package_request=None, query=None, args=()) → List[PackageEntry]

    Returns the list of known packages Entries matching a PackageRequest

    Args:

      package_request (PackageRequest): request

    Returns:

      list (of PackageEntry)

  personal_certificate()

    Returns the personal certificates chain

    Returns:

      list (of SSLCertificate). The first one is the personal certificate. The other are useful if intermediate CA are used.

  property pre_shutdown_timeout

    get / set the pre shutdown timeout shutdown tasks.

  private_key(private_key_password=None)

    SSLPrivateKey matching the personal_certificate When key has been found, it is kept in memory for later use.

    Args:

      private_key_password : password to use to decrypt key. If None, passwd_callback is called.

    Returns:

      SSLPrivateKey

    Raises:

      EWaptMissingPrivateKey if ket can not be decrypted or found.

  property private_key_password_callback
  property public_certs_dir: str
  public_installed_package_names()

    Public list of installed packages

  public_params = ['server_uuid', 'uuid', 'hostname', 'hardware_uuid', 'host_organizational_unit_dn', 'licences', 'domain_info', 'last_domain_info_date', 'host_description', 'last_successful_register']
  property publicdbpath
  reachable_ip()

    Return the local IP which is most probably reachable by wapt server

    In case there are several network connections, returns the local IP

      which Windows choose for sending packets to WaptServer.

    This can be the most probable IP which would get packets from WaptServer.

    Returns:

      str: Local IP

  read_audit_data(section, key, default=None, ptype=None, include_expired_data=True)

    Retrieve the latest value associated with section/key from database

  read_audit_data_set(section, key, as_dict=False, raw_data=False, descending=True)

    Retrieve all the values associated with section/key from database

  read_audit_data_since(last_query_date=None, raw_data=False) → Generator[Tuple]

    Retrieve all the values from database after last_query_date order by last_query_date

    Returns

      Generator[Tuple[‘id’,’value_section’, ‘value_key’, ‘value_date’, ‘value’, ‘expiration_date’]]

  read_ini_setting(key: str, section='global')

    Read an initial setting in the current wapt ini config file (ie wapt-get.ini) Takes in account potential default_<section> section which must be updated too in case of use of dynamic json config. Returns a list if key is in list_config_attributes

  read_param(name, default=None, ptype=None, public=None)

    read a param value from local db if public==True, try first in public db then in private this handle the case where private db is not accessible by non admin users. >>> wapt = Wapt(config_filename=’c:/wapt/wapt-get.ini’) >>> wapt.read_param(‘db_version’) u’20140410’

  read_upgrade_status()

    Return last stored pending updates status

    Returns:

      dict: {running_tasks errors pending (dict) upgrades (list)}

  register_computer(description=None, retry_with_password=False)

    Send computer informations to WAPT Server if description is provided, updates local registry with new description

    Returns:

      dict: response from server.

        >>> wapt = Wapt()
        >>> s = wapt.register_computer()
        >>>

  registration_inventory()

    Minimum inventory for initial registration

  registry_uninstall_snapshot()

    Return list of uninstall ID from registry launched before and after an installation to capture uninstallkey

  reload_config_if_updated()

    Check if config file has been updated, Return None if config has not changed or date of new config file if reloaded

        >>> wapt = Wapt(config_filename='c:/wapt/wapt-get.ini')
        >>> wapt.reload_config_if_updated()

  remove(packages_list, force=False, only_priorities=None, only_if_not_process_running=False, uninstalled_by=None)

    Removes a package giving its package name, unregister from local status DB

    Args:
      packages_list (str or list or path): packages to remove (package name,

        list of package requirement, package entry or development directory)

      force : if True, unregister package from local status database, even if uninstall has failed

    Returns:

      dict: {‘errors’: [], ‘removed’: [], ‘not_allowed’: []}

  remove_is_allowed(package: str, usergroups: List[str]) → bool
  remove_json_config(config_name: str) → List

    Remove a json config given its name

    Returns:

      List: list of removed files

  remove_package_persistent_dirs(package_uuid)
  remove_upgrade_shutdown_policy()

    Add a local shitdown policy to upgrade system

  property repositories: List[WaptRemoteRepo]
  reset_host_organizational_unit_dn()

    Reset forced host_organizational_unit_dn to AD / GPO registry defaults. If it was forced in ini file, remove setting from ini file.

  reset_host_uuid(new_uuid=None)

    Reset host uuid to bios provided UUID. If it was forced in ini file, remove setting from ini file.

  reset_settings()
  run(*arg, **args)
  run_notfatal(*cmd, **args)

    Runs the command and wait for it termination returns output, don’t raise exception if exitcode is not null but return ‘’

  running_tasks()

    return current install tasks

  property runstatus: str

    returns the current run status for tray display

  save_domain_info(info)
  save_external_ip(ip)
  save_last_domain_info_date(lastdate)
  search(searchwords=[], exclude_host_repo=True, section_filter=None, newest_only=False, with_install_status=False, limit=None)

    Returns a list of packages which have the searchwords in their description

    Args:

      searchwords (str or list): words to search in packages name or description exclude_host_repo (boolean): if True, don’t search in host repoisitories. section_filter (str or list): restrict search to the specified package sections/categories

    Returns:

      list: list of PackageEntry

  self_service_auth(login, password, host_uuid, groups)

    Sends login and password to server, who then checks if it’s a valid user

    Returns:

      list: groups the user belongs to.

  server_uuid()
  session_setup(package, force=False, params=None)

    Setup the user session for a specific system wide installed package” Source setup.py from database or filename

  set_client_cert_auth(connection, force=False)

    Set client side ssl authentication for a waptserver or a waptrepo using host_certificate if client_certificate is not yet set in config and host certificate is able to do client_auth

    Args:

      connection: object with client_certificate, client_private_key and client_auth

  set_package_attribute(package, key, value, public=False)

    Store in local db a key/value pair for later use

  show_progress(show_box=False, msg='Loading...', progress=None, progress_max=None)

    Global hook to report progress feedback to the user

    Args:

      show_box (bool): indicate to display or hide the notification msg (str): A status message to display. If None, nothing is changed. progress (float): Completion progress_max (float): Target of completion.

  sign_host_content(data)

    Sign data str with host private key with sha256 + RSA Args:

    > data (bytes) : data to sign

    Returns

      bytes: signature of sha256 hash of data.

  store_public_setuppy_control(package_entry: PackageEntry, install_date: Optional[str] = None, install_by: Optional[str] = None)

    Update status of package installation on publicdb

  store_upgrade_status(upgrades=None)

    Stores in DB the current pending upgrades and running installs for query by waptservice

  trust_package_signer(cert)

    Add a certificate to the list of trusted package signers certificates Stores the PEM encoded data in public_certs_dir directory. The certificate is added to this current Wapt.cabundle instance for immediate use (until config is reloaded)

  uninstall(packagename, params_dict={}, force=False)

    Launch the uninstall script of an installed package” Source setup.py from database or filename

  uninstall_cmd(guid)

    return the (quiet) command stored in registry to uninstall a software given its registry key

  unregister_computer()

    Remove computer informations from WAPT Server

    Returns:

      dict: response from server.

        >>> wapt = Wapt()
        >>> s = wapt.unregister_computer()
        >>>

  untrust_package_signer(cert)

    Removes a certificate from the list of trusted package signers certificates based on the fingerprint of the certificate. Certs in ssl public_certs_dir with matching fingerprint are deleted.

  update(force=False, register=True) → Dict[str, Union[List[PackageEntry], int, List[str], str, Dict]]

    Update local database with packages definition from repositories

    Args:
      force (boolean): update even if Packages index on repository has not been

        updated since last update (based on http headers)

      register (boolean): Send informations about status of local packages to waptserver

    Returns:
      dict: {

        “added”:list(PackageEntry), “removed”:list(PackageEntry), “count”:int, “discarded_count”:int, “repos”:list(str), “upgrades”: {‘additional’: [PackageEntry],

        > > ‘immediate_installs’: [PackageEntry], ‘install’: [PackageEntry], ‘remove’: [PackageEntry], ‘upgrade’: [PackageEntry]

        > }

        “repos”:[str], “date”:str, “errors”:[str], “next_update_on”: {repo_name:datestr} }

        >>> wapt = Wapt(config_filename='c:/wapt/wapt-get.ini')
        >>> updates = wapt.update()
        >>> 'count' in updates and 'added' in updates and 'upgrades' in updates and 'date' in updates and 'removed' in updates
        True

  update_crls(force=False)
  update_licences(force=False)
  update_package_install_status(**kwargs)

    Update the install status

  update_public_packages_availability()

    Update package removal_date on publicdb

  update_repo_rules(force=False)
  update_server_status(force=False, excluded_keys=[], errors=None) → dict
    Send host_info, installed packages and installed softwares,

      and last update status informations to WAPT Server, but don’t send register info like dmi or wmi.

    Returns:

      dict: server response

    Changed in version 1.4.3: if last status has been properly sent to server and data has not changed, don’t push data again to server. the hash is stored in memory, so is not pass across threads or processes.

        >>> wapt = Wapt()
        >>> s = wapt.update_server_status()
        >>>

  upgrade(only_priorities=None, only_if_not_process_running=False)

    Install “well known” host package from main repository if not already installed then query localstatus database for packages with a version older than repository and install all newest packages

    Args:

      priorities (list of str): If not None, upgrade only packages with these priorities.

    Returns:
      dict: {‘upgrade’: [], ‘additional’: [], ‘downloads’:

        > {‘downloaded’: [], ‘skipped’: [], ‘errors’: []},

        ‘remove’: [], ‘skipped’: [], ‘install’: [], ‘errors’: [], ‘unavailable’: []}

  wapt_status()

    Wapt configuration and version informations

    Returns:
      dict: versions of main main files, waptservice config,

        repos and waptserver config

        >>> w = Wapt()
        >>> w.wapt_status()
        {
                'setuphelpers-version': '1.1.1',
                'waptserver': {
                        'wapt_server': u'tranquilit.local',
                        'proxies': {
                                'http': None,
                                'https': None
                        },
                        'server_url': 'https: //wapt.tranquilit.local'
                },
                'waptservice_protocol': 'http',
                'repositories': [{
                        'wapt_server': u'tranquilit.local',
                        'proxies': {
                                'http': None,
                                'https': None
                        },
                        'name': 'global',
                        'repo_url': 'http: //wapt.tranquilit.local/wapt'
                },
                {
                        'wapt_server': u'tranquilit.local',
                        'proxies': {
                                'http': None,
                                'https': None
                        },
                        'name': 'wapt-host',
                        'repo_url': 'http: //srvwapt.tranquilit.local/wapt-host'
                }],
                'common-version': '1.1.1',
                'wapt-exe-version': u'1.1.1.0',
                'waptservice_port': 8088,
                'wapt-py-version': '1.1.1'
        }

  property waptdb: WaptDB

    Wapt database

  property waptpublicdb: WaptPublicDB

    Wapt database

  property waptserver: WaptServer
  waptserver_available() → bool

    Test reachability of waptserver.

    If waptserver is defined and available, return True, else False

    Returns:

      boolean: True if server is defined and actually reachable

  waptserver_login()

    Login on waptserver and add the session cookies to self.waptserver.session

  waptserver_logout()
  property waptsessiondb: WaptSessionDB

    Wapt user session database

  waptwua(as_context_manager: bool = False) → pywaptwua

    Return pywaptwua module configured properly with current Wapt agent settings

    Args:

      as_context_manager (bool): save running state of wuauserv service, restore it when leaving context.

    Returns:

      module or context handler returning pywaptwua moduel on enter and exit

  wget_download_report(source_type, source, url: str, total_downloaded, start_time, end_time: int) → None
  write_audit_data(section, key, value, ptype=None, value_date=None, expiration_date=None, max_count=2, keep_days=None)

    Stores in database a metrics, removes expired ones

    Args:

      section (str) key (str) value (any) value_date (str or datetime): value date (utc). By default datetime.datetime.utcnow() expiration_date (str) : expiration date of the new value max_count (int) : keep at most max_count value. remove oldest one. keep_days (int) : set the expiration date to now + keep_days days. override expiration_date arg if not None

    Returns:

      None

  write_audit_data_if_changed(section, key, value, ptype=None, value_date=None, expiration_date=None, max_count=2, keep_days=None)

    Write data only if different from last one

    Returns:

      previous value

  write_config(config_filename=None)

    Update configuration parameters to supplied inifilename

  write_ini_setting(key: str, value, section='global')

    Write a setting in the current wapt ini config file (ie wapt-get.ini) Takes in account potential default_<section> section which must be updated too in case of use of dynamic json config. Don’t write anything if value is still properly set.

  write_param(name, value, public=None)

    Store in local db a key/value pair for later use

  property wua_repository: WaptRepo

class common.WaptBaseDB(dbpath)

  Bases: `BaseObjectClass`

  begin()
  commit()
  create_db_structure()
  curr_db_version = None
  property db: Connection
  property db_version
  property dbpath
  delete_param(name)
  execute(query: str, args=()) → Cursor

    Wrapper around sqlite.execute.

  get_param(name, default=None, ptype=None)

    Retrieve the value associated with name from database

  has_param(name: str) → bool

    Check if param exists

  init_db_data()
  query(query, args=(), one=False, as_dict=True) → List[dict]

    Execute the query and return a list of dict by default if as_dict is False, returns a list of tuple

    Returns:

      list of doct

  rollback()
  set_param(name, value, ptype=None)

    Store permanently a (name/value) pair in database, replace existing one

  upgradedb(force=False)

    Update local database structure to current version if rules are described in db_upgrades

    Args:

      force (bool): force upgrade even if structure version is greater than requested.

    Returns:

      tuple: (old_structure_version,new_structure_version)

class common.WaptDB(dbpath)

  Bases: `WaptBaseDB`

  Class to manage SQLite database with local installation status

  add_package_entry(package_entry, locale_code=None) → int

    Add a package into the database

  add_start_install(package_entry: PackageEntry, params_dict={}, explicit_by=None) → int

    Register the start of installation in local db

    Args:

      package_entry (PackageEntry): package params_dict (dict) : dictionary of parameters provided on command line with –param or by the server explicit_by (str) : username of initiator of the install.

      > if not None, install is not a dependencie but an explicit manual install

      setuppy (str)python source code used for install, uninstall or session_setup

        code used for uninstall or session_setup must use only wapt self library as package content is no longer available at this step.

    Returns:

      int : rowid of the inserted install status row

  audit_status() → str

    Return WORST audit status among properly installed packages

    Return:

      str

  build_depends(packages: List[str], packages_filter: Optional[PackageRequest] = None) → Tuple[List[str], List[str], List[str]]

    Given a list of packages conditions (packagename (optionalcondition)) return a list of dependencies (packages conditions) to install

    Args:

      packages (list of str): list of packages requirements ( package_name(=version) )

    Returns:

      (list depends,list conflicts,list missing) : tuple of (all_depends,missing_depends)

    TODO : choose available dependencies in order to reduce the number of new packages to install

        >>> waptdb = WaptDB(':memory:')
        >>> office = PackageEntry('office','0')
        >>> firefox22 = PackageEntry('firefox','22')
        >>> firefox22.depends = 'mymissing,flash'
        >>> firefox24 = PackageEntry('firefox','24')
        >>> thunderbird = PackageEntry('thunderbird','23')
        >>> flash10 = PackageEntry('flash','10')
        >>> flash12 = PackageEntry('flash','12')
        >>> office.depends='firefox(<24),thunderbird,mymissing'
        >>> firefox22.depends='flash(>=10)'
        >>> firefox24.depends='flash(>=12)'
        >>> waptdb.add_package_entry(office)
        >>> waptdb.add_package_entry(firefox22)
        >>> waptdb.add_package_entry(firefox24)
        >>> waptdb.add_package_entry(flash10)
        >>> waptdb.add_package_entry(flash12)
        >>> waptdb.add_package_entry(thunderbird)
        >>> waptdb.build_depends('office')
        ([u'flash(>=10)', u'firefox(<24)', u'thunderbird'], [u'mymissing'])

  create_db_structure() → str

    Initialize current sqlite db with empty table and return structure version

  curr_db_version = '20240930'
  get_not_installed_from_uuids(uuids)
  get_packages_from_uuids(uuids)
  get_status_revision()
  init_db_data()
  install_status(id)

    Return the local install status for id

    Args:

      id: sql rowid

    Returns:

      dict : merge of package local install, audit and package attributes.

  installed(include_errors=False, include_setup=True, include_control=False)

    Return a list of installed packages on this host (status ‘OK’ or ‘UNKNWON’)

    Args:
      include_errors (bool)if False, only packages with status ‘OK’ and ‘UNKNOWN’ are returned

        if True, all packages are installed.

      include_setup (bool) : if True, setup.py files content is in the result rows

    Returns:

      list: of installed PackageEntry

  installed_matching(package_cond: str, include_errors=False, include_setup=True, include_control=False) → PackageEntry

    Return the properly installed (if include_errors=False) package match the package condition ‘tis-package (>=version)’

    Args:

      package_cond (str): package requirement to lookup include_errors

    Returns:

      PackageEntry merge with localstatus attributes WITH setuppy

  installed_packages_ids() → List[int]

    Return list of id of package install status

  installed_packages_inventory(since_status_revision=None) → List[Tuple]

    Return a list of installed packages status suitable for inventory

    List of list. First line is the header (fields names)

    Returns:

      list (of tuple): of installed packages. First item is the header (list of field names)

  installed_search(searchwords=[], include_errors=False)

    Return a list of installed package entries based on search keywords

    Returns:

      list of PackageEntry merge with localstatus attributes without setuppy

  installed_status(include_errors=False, include_setup=False, include_control=False, include_log=False)

    Return a list of installed packages on this host (status ‘OK’ or ‘UNKNWON’)

    Args:
      include_errors (bool)if False, only packages with status ‘OK’ and ‘UNKNOWN’ are returned

        if True, all packages are installed.

      include_setup (bool) : if True, setup.py files content is in the result rows

    Returns:

      dict[package_uuid]: install and audit infos

  known_packages()

    Return a dict of all known packages PackageKey(s) indexed by package_uuid

    Returns:

      dict {‘package_uuid’:PackageKey(package)}

  package_install_status(package_uuid: str) → Dict

    Return the local install status for id

    Args:

      package_uuid: sql rowid

    Returns:

      dict or None: merge of package local install, audit and package attributes.

  packages_audit_inventory(after_date=None)

    Return a list of packages audit status suitable for inventory

    List of list. First line is the header (fields names)

    Returns:

      list (of list): of installed packages

  packages_matching(package_cond)

    Return an ordered list of available packages entries which match the condition “packagename[([=<>]version)]?” version ascending

    Args:

      package_cond (PackageRequest or str): filter packages and determine the ordering

    Returns:

      list of PakcageEntry

  packages_search(searchwords=[], exclude_host_repo=True, section_filter=None, packages_filter=None, limit=None)

    Return a list of package entries matching the search words

    Args:

      searchwords (list): list of words which must be in package name or description exclude_host (bool): don’t take in account packages comming from a repo named ‘wapt-host” section_filter (list): list of packages sections to take in account packages_filter (PackageRequest): additional filters (arch, locale, maturities etc…)

      > to take in account for filter and sort

    Returns:

      list of PackageEntry

  params(packagename)

    Return install parameters associated with a package

  purge_repo(repo_name)

    remove references to repo repo_name

        >>> waptdb = WaptDB('c:/wapt/db/waptdb.sqlite')
        >>> waptdb.purge_repo('main')

  query_package_entry(query, args=(), one=False, package_request=None, limit=None)

    Execute the query on the db try to map result on PackageEntry attributes Fields which don’t match attributes are added as attributes (and listed in _calc_attributes list)

    Args:

      query (str): sql query args (list): parameters of the sql query package_request (PackageRequest): keep only entries which match package_request one(bool): if True, return the highest available version (if package_request is not None, use it to compare packages)

    Result:

      PackageEntry or list of PackageEntry

        >>> waptdb = WaptDB(':memory:')
        >>> waptdb.add_package_entry(PackageEntry('toto','0',repo='main'))
        >>> waptdb.add_package_entry(PackageEntry('dummy','2',repo='main'))
        >>> waptdb.add_package_entry(PackageEntry('dummy','1',repo='main'))
        >>> waptdb.query_package_entry("select * from wapt_package where package=?",["dummy"])
        [PackageEntry('dummy','2'), PackageEntry('dummy','1')]
        >>> waptdb.query_package_entry("select * from wapt_package where package=?",["dummy"],one=True)
        PackageEntry('dummy','2')

  remove_install_status(package=None, package_uuid=None)

    Remove status of package installation from localdb

  switch_to_explicit_mode(package, user_id) → int

    Set package install mode to manual so that package is not removed when meta packages don’t require it anymore

  update_audit_status(rowid, set_status=None, set_output=None, append_line=None, set_last_audit_on=None, set_next_audit_on=None) → int

    Update status of package installation on localdb

  update_install_status(rowid, set_status=None, append_line=None, uninstall_key=None) → int

    Update status of package installation on localdb

  update_install_status_pid(pid, set_status='ERROR') → int

    Update status of package installation on localdb

  upgradeable(include_errors=True, check_version_only=True, include_setup=False, include_control=False)

    Return a dictionary of upgradable Package entries

    Returns:

      dict ‘package’: [candidates] order by mot adequate to more generic and

  upgradeable_status() → List[Tuple[PackageEntry, PackageEntry]]

    Return a list of upgradable Package entries. (faster than upgradeable() )

    Returns:
      list of (installed PackageEntry, candidate PackageEntry).

        only install_status,package_uuid,package,version,section,priority,maturity,locale aatributes are returned.

  wapt_package_columns = {'architecture': 'varchar', 'audit_schedule': 'varchar', 'categories': 'varchar', 'changelog': 'varchar', 'conflicts': 'varchar', 'depends': 'varchar', 'description': 'varchar', 'editor': 'varchar', 'filename': 'varchar', 'forced_install_on': 'varchar', 'homepage': 'varchar', 'icon_sha256sum': 'varchar', 'id': 'INTEGER PRIMARY KEY AUTOINCREMENT', 'impacted_process': 'varchar', 'installed_size': 'integer', 'keywords': 'varchar', 'licence': 'varchar', 'locale': 'varchar', 'maintainer': 'varchar', 'maturity': 'varchar', 'max_os_version': 'varchar', 'md5sum': 'varchar', 'min_os_version': 'varchar', 'min_wapt_version': 'varchar', 'name': 'varchar', 'package': 'varchar', 'package_uuid': 'varchar', 'priority': 'varchar', 'repo': 'varchar', 'repo_url': 'varchar', 'section': 'varchar', 'signature': 'varchar', 'signature_date': 'varchar', 'signed_attributes': 'varchar', 'signer': 'varchar', 'signer_fingerprint': 'varchar', 'size': 'integer', 'sources': 'varchar', 'target_os': 'varchar', 'valid_from': 'varchar', 'valid_until': 'varchar', 'version': 'varchar'}

class common.WaptHostRepo(url=None, name='wapt-host', verify_cert=None, http_proxy=None, timeout=None, host_id=None, cabundle=None, config=None, section=None, host_key=None, WAPT=None)

  Bases: `WaptRepo`

  Dummy http repository for host packages

      >>> host_repo = WaptHostRepo(name='wapt-host',host_id=['0D2972AC-0993-0C61-9633-529FB1A177E3','4C4C4544-004E-3510-8051-C7C04F325131'])
      >>> host_repo.load_config_from_file(r'C:\Users\htouvet\AppData\Local\waptconsole\waptconsole.ini')
      >>> host_repo.packages()
      [PackageEntry('0D2972AC-0993-0C61-9633-529FB1A177E3','10') ,
       PackageEntry('4C4C4544-004E-3510-8051-C7C04F325131','30') ]

  download_packages(package_requests, target_dir=None, usecache=True, printhook=None)

    Download a list of packages from repo

    Args:

      package_request (list,PackageEntry): a list of PackageEntry to download target_dir (str): where to store downloaded Wapt Package files usecache (bool): wether to try to use cached Wapt files if checksum is ok printhook (callable): to show progress of download

    Returns:

      dict: {“downloaded”:[local filenames],”skipped”:[filenames in cache],”errors”:[],”packages”:self.packages()}

  property host_id
  host_package_url(host_id=None)
  is_available()

    Check if repo is reachable an return creation date of Packages.

    Try to access the repo and return last modified date of repo index or None if not accessible

    Returns:

      str: Iso creation date of remote Package file as returned in http headers

        >>> repo = WaptRemoteRepo(name='main',url='https://wapt/wapt',timeout=1)
        >>> repo.is_available() <= datetime2isodate()
        True
        >>> repo = WaptRemoteRepo(name='main',url='https://badwapt/wapt',timeout=1)
        >>> repo.is_available() is None
        True

  load_config(config, section=None)

    Load waptrepo configuration from inifile section.

    Use name of repo as section name if section is not provided. Use ‘global’ if no section named section in ini file

  property repo_url

    Repository URL

    Fixed url if none is set in wapt-get.ini by querying the server.

    The URL is queried once and then cached into a local property.

    Returns:

      str: url to the repository

        >>> repo = WaptRepo(name='wapt',timeout=4)
        >>> print repo.wapt_server
        http://wapt.wapt.fr/
        >>> repo = WaptRepo(name='wapt',timeout=4)
        >>> print repo.wapt_server
        http://wapt.wapt.fr/
        >>> print repo.repo_url
        http://srvwapt.tranquilit.local/wapt

class common.WaptPackageAuditLogger(console, wapt_context=None, install_id=None, user=None, running_status='RUNNING', exit_status=None, error_status='ERROR')

  Bases: `LogOutput`

  Context handler to log all print messages to a wapt package audit log

  Args:

    console (file) : sys.stderr wapt_context (Wapt): Wapt instance install_id (int): name of running or installed package local status where to log status and output

      >>>

class common.WaptPackageInstallLogger(console, wapt_context=None, install_id=None, user=None, running_status='RUNNING', exit_status='OK', error_status='ERROR')

  Bases: `LogOutput`

  Context handler to log all print messages to a wapt package install log

  Args:

    wapt_context (Wapt): Wapt instance package_name (str): name of running or installed package local status where to log status and output

      >>>

class common.WaptPackageSessionSetupLogger(console, waptsessiondb, install_id, running_status='RUNNING', exit_status=None, error_status='ERROR')

  Bases: `LogOutput`

  Context handler to log all print messages to a wapt package install log

  Args:

    wapt_context (Wapt): Wapt instance package_name (str): name of running or installed package local status where to log status and output

      >>>

class common.WaptPublicDB(dbpath)

  Bases: `WaptBaseDB`

  create_db_structure() → str

    Initialize current sqlite db with empty table and return structure version

  curr_db_version = '20250114'

class common.WaptRepo(url=None, name='wapt', verify_cert=None, http_proxy=None, timeout=None, cabundle: [<class 'waptcrypto.SSLCABundle'>, typing.Callable[[], waptcrypto.SSLCABundle]] = None, config: ~iniparse.compat.RawConfigParser = None, section=None, WAPT: Wapt = None)

  Bases: `WaptRemoteRepo`

  Gives access to a remote http repository, with a zipped Packages packages index Find its repo_url based on * repo_url explicit setting in ini config section [<name>] * if there is some rules use rules >>> repo = WaptRepo(name=’main’,url=’http://wapt/wapt’,timeout=4) >>> packages = repo.packages() >>> len(packages)

  property WAPT
  as_dict()

    returns a dict representation of the repository configuration and parameters

  property cached_wapt_repo_url
  find_wapt_repo_url() → str

    Find a wapt_repo_url from rules Returns:

    > str: URL to the repo.

  load_config(config, section=None)

    Load waptrepo configuration from inifile section.

    Use name of repo as section name if section is not provided. Use ‘global’ if no section named section in ini file

  property proxies: Dict[str, str]

    dict for http proxies url suitable for requests based on the http_proxy repo attribute

    Returns:

      dict: {‘http’:’http://proxy:port’,’https’:’http://proxy:port’}

  property repo_url

    Repository URL

    Fixed url if none is set in wapt-get.ini by querying the server.

    The URL is queried once and then cached into a local property.

    Returns:

      str: url to the repository

        >>> repo = WaptRepo(name='wapt',timeout=4)
        >>> print repo.wapt_server
        http://wapt.wapt.fr/
        >>> repo = WaptRepo(name='wapt',timeout=4)
        >>> print repo.wapt_server
        http://wapt.wapt.fr/
        >>> print repo.repo_url
        http://srvwapt.tranquilit.local/wapt

  reset_network()

    called by wapt when network configuration has changed

  property rules
  rulesdb()

    Get rules from DB

class common.WaptServer(url=None, proxies={'http': None, 'https': None}, timeout=5.0, dnsdomain=None, name='waptserver')

  Bases: `BaseObjectClass`

  Manage connection to waptserver

  as_dict()
  ask_user_password(action=None, with_otp=None)

    Ask for basic auth if server requires it

  auth(action=None, enable_password_callback=True)

    Return an authenticator for the action. This is basically a tuple (user,password) or a more sophisticated AuthBase descendent. The motivation for action is to not request password from user if not needed.

    Args:

      action (str): for which an authenticator is requested

    Returns:

      tuple or requests.auth.AuthBase descendant instance

  available() → bool
  clear_session()
  client_auth()

    Return SSL pair (cert,key) filenames for client side SSL auth

    Returns:

      tuple: (cert path,key path,strkeypassword)

  get(action, auth=None, timeout=None, use_ssl_auth=True, enable_capture_external_ip=True, enable_password_callback=True, decode_json=True)

    Make a get http request to the server, and return result decoded from json This assuems remo

    Args:

      action (str): doc part of the url auth (tuple): authentication passed to requests (user,password) enable_capture_external_ip (bool) : if true and callback is defined, try to get external IP from X-Remote-IP header

      > and set it though self.capture_external_ip_callback

      enable_password_callback (bool) : if true, password callback will be called if needed.

    Returns:

      dict : response returned from server as json data.

  get_private_key_password(location, identity)
  get_requests_session(use_ssl_auth=True) → Session
  head(action, auth=None, timeout=None, use_ssl_auth=True, enable_capture_external_ip=True, enable_password_callback=True)
  load_config(config, section='global')

    Load waptserver configuration from inifile

  load_config_from_file(config_filename, section='global')

    Load waptserver configuration from an inifile located at config_filename

    Args:

      config_filename (str) : path to wapt inifile section (str): ini section from which to get parameters. default to ‘global’

    Returns:

      WaptServer: self

  post(action, data=None, files=None, auth=None, timeout=None, signature=None, signer=None, content_length=None, use_ssl_auth=True, enable_capture_external_ip=True, enable_password_callback=True, max_retry_count=3)

    Post data to waptserver using http POST method

    Add a signature to the posted data using host certificate.

    Posted Body is gzipped

    Args:

      action (str): doc part of the url data (str) : posted data body files (list or dict) : list of filenames

    Returns:

      dict : response returned from server as json data.

  reset_network()

    called by wapt when network configuration has changed

  save_server_certificate(server_ssl_dir, overwrite=False)

    Retrieve certificate of https server for further checks

    Args:

      server_ssl_dir (str): Directory where to save x509 certificate file

    Returns:

      str : full path to x509 certificate file.

  property server_url

    Return fixed url if any

        >>> server = WaptServer(timeout=4)
        >>> print server.server_url
        https://wapt.tranquil.it

class common.WaptSessionDB(username='')

  Bases: `WaptBaseDB`

  add_start_install(package_entry)

    Register the start of installation in local db

    Returns:

      int : rowid of the inserted record

  create_db_structure()

    Initialize current sqlite db with empty table and return structure version

  curr_db_version = '20201217'
  is_installed(package, version)
  remove_install_status(package)

    Remove status of package installation from localdb

        >>> wapt = Wapt()
        >>> wapt.forget_packages('tis-7zip')
        ???

  remove_obsolete_install_status(installed_packages) → int

    Remove local user status of packages no more installed

  update_install_status(rowid, set_status=None, append_line=None)

    Update status of package installation on localdb

  update_install_status_pid(pid, set_status='ERROR')

    Update status of package installation on localdb

common.authorized_packages_for_token(wapt: Wapt, token: str, secret_key: str, package_requests: Optional[List] = None) → List

common.check_is_member_of(huser, group_name)

  Check if a user is a member of a group

  Args:

    huser (handle) : pywin32 group_name (str) : group

      >>> from win32security import LogonUser
      >>> hUser = win32security.LogonUser ('technique','tranquilit','xxxxxxx',win32security.LOGON32_LOGON_NETWORK,win32security.LOGON32_PROVIDER_DEFAULT)
      >>> check_is_member_of(hUser,'domain admins')
      False

common.check_user_membership(user_name, password, domain_name, group_name)

  Check if a user is a member of a group

  Args:

    user_name (str): user password (str): domain_name (str) : If empty, check local then domain group_name (str): group

      >>> from win32security import LogonUser
      >>> hUser = win32security.LogonUser ('technique','tranquilit','xxxxxxx',win32security.LOGON32_LOGON_NETWORK,win32security.LOGON32_PROVIDER_DEFAULT)
      >>> check_is_member_of(hUser,'domain admins')
      False

common.get_domain_admins_group_name()
  Return localized version of domain admin group (ie “domain admins” or

    “administrateurs du domaine” with RID -512)

      >>> get_domain_admins_group_name()
      u'Domain Admins'

common.get_local_admins_group_name()

common.is_system_user()

common.lookup_name_from_rid(domain_controller, rid)
  return username or group name from RID (with localization if applicable)

    from https://mail.python.org/pipermail/python-win32/2006-May/004655.html domain_controller : should be a DC rid : integer number (512 for domain admins, 513 for domain users, etc.)

      >>> lookup_name_from_rid('srvads', DOMAIN_GROUP_RID_ADMINS)
      u'Domain Admins'

common.self_service_rules(wapt: Wapt) → CaseInsensitiveDict

  Returns dict of allowed packages for users and groups

common.sid_from_rid(domain_controller, rid)

  Return SID structure based on supplied domain controller’s domain and supplied rid rid can be for example DOMAIN_GROUP_RID_ADMINS, DOMAIN_GROUP_RID_USERS

common.tryurl(url, proxies=None, timeout=5.0, auth=None, verify_cert=False, cert=None)

common.wapt_sources_edit(wapt_sources_dir: str, editor_for_packages: Optional[str] = None) → str
  Utility to open PyScripter or the configured editor with package sources if it is installed

    else open the wapt package development directory in System Shell Explorer.

  Args

    wapt_sources_dir (str): directory path of the wapt package sources

  Returns:

    str: sources path

# waptlicences

Module to check or sign licences

waptlicences.activate_licence(licence: str; server_uuid: str) -> (licence:str, message:str)

waptlicences.apply_json_config_by_config_name(json_config_data:str, config_name:str=None, check_hash: str=None; cleanup_config: bool=False, ini_filename:str=None) → bool

waptlicences.bootup_time_utc() → int

  Returns last boot time in Unix milliseconds

waptlicences.build_qrcode_console()

  build_qrcode_console(data:str, TT=None,TF=None,FT=None,FF=None): List[List[]]

waptlicences.build_qrcode_png()

  def build_qrcode_png(data:str, size:int=6)->bytes: …

waptlicences.check_exe_signing_certificate(exe_filename: str)

waptlicences.check_licence_signature()

  licence_json:str -> int. Check if licence is properly signed. (0:lsValid, 1: lsUnknown, 2: lsNotJson, 3: lsBadServer, 4: lsBadSignature, 5: lsNotYetValid, 6: lsExpired,7: lsDuplicated)

waptlicences.check_msi_signature(msi_filename: str)

waptlicences.check_password_complexity(password: str, min_len: int) → bool. Return True if password is string enough.

waptlicences.check_valid_licences_count()
  Args:

    licences_json:str server_uuid:str ttl_secs:int -> dict

  Returns:

    {“count”:int, “licenced_to”:str,”warning”:str, “licences”: list}

waptlicences.clear_stripped_down_ca_cache(force: bool = False) → bool

waptlicences.compute_negotiate_server_authenticate_header(keytab_path: str, input_headers: str) → Dict[str, str]
  parse HTTP input headers and perform Negotiate/Kerberos authentication

    - will identify ‘Authorization: Negotiate <base64 encoding>’ HTTP header

    - assuming a simple two-way Negotiate/Kerberos handshake

  Returns Dict: {auth_user, www_authenticate} or None on error

waptlicences.cpu_infos_text() → str

  Return description of CPU like ‘4 x Intel(R) Core(TM) i5-7300U CPU @ 2.60GHz [3MB]’

waptlicences.decrypt_aes_cbc(data, key: bytes, iv: bytes = None) → bytes

  decrypt data with AES CBC CTS algorithm

waptlicences.decrypt_aes_pkcs7(data, key: bytes, iv: bytes = None, salt: str = 'wapt', round: int = 10000) → bytes

  decrypt data with AES CBC algorithm and Pkcs#7 message padding

waptlicences.edit_wapt_sources(sources_dir: str, editor_for_packages: str=')

waptlicences.encrypt_aes_cbc(data, key: bytes, iv: bytes = None) → bytes

  encrypt data with AES CBC CTS algorithm

waptlicences.encrypt_aes_pkcs7(data, key: bytes, iv: bytes = None, salt: str = 'wapt', round: int = 10000) → bytes

  encrypt data with AES CBC algorithm and Pkcs#7 message padding

waptlicences.evaluate(expression: str, vars: dict = None) → Any[None, int, str, bool, float]

waptlicences.get_battery_infos(idx: int) → dict

  Informations on battery. Args:

  > idx (int): battery index

  Returns:

    dict

waptlicences.get_bios_infos()

  Return a dict SM Bios informations. Needs to be root/admin

waptlicences.get_catis_pem()

  -> str Returns PEM X509 data for TIS licencing certificate

waptlicences.get_catislic_pem()

  -> str Returns PEM X509 data for relicencing certificate

waptlicences.get_code_signing_tis_pem()

  -> str Returns PEM X509 Code signing certificate for TIS

waptlicences.get_djoin_infos(filename: str, base64: str = None) → dict

  Informations on a djoin base64 file. Args:

  > filename (str): filename containing the djoin in base64 format. Exclusive with base64. base64 (str): base64 string of the djoin. Exclusive with filename.

  Returns:

    dict

waptlicences.get_dmi_infos()

  Return a dict with all decoded Bios informations. Needs to be root/admin

waptlicences.get_exe_certificate_stuff()

  exefilename:str -> data:bytes

waptlicences.get_exe_config_descriptions()

  exefilename:str -> list

waptlicences.get_ip_addresses(kind: int = 0) → list[str]

  tiaAny = 0; tiaIPv4 = 1; tiaIPv6 = 2; tiaIPv4Public = 3; tiaIPv4Private = 4; tiaIPv4Dhcp = 5; tiaIPv4DhcpPublic = 6; tiaIPv4DhcpPrivate = 7;

waptlicences.get_local_ip_address(remote: str) → str

waptlicences.get_mac_addresses(up_and_down: bool, flush_cache: bool = True) → list[dict]

waptlicences.get_main_mac_address(interface_name: str, filter: int, flush_cache: bool = True) → dict

waptlicences.get_monotonic_stats() → Dict

waptlicences.get_peer_cert_chain_from_server(url: str, server_ssl_dir: str, proxy: str = None, fail_if_exists: bool = false) → str
  Returns:

    str: path to server certificate in server_ssl_dir

waptlicences.get_pefile_properties(exe_filename: str) → dict

waptlicences.get_server_ca(url: str, proxy: str = None) → str
  Returns:

    str: PEM encoded X509 server CA certificate issuer

waptlicences.get_stripped_down_server_ca_bundle_path(url: str, proxy: str = None, max_age_secs: int = 3600, ca_bundle_path: str = None) → str

  Build a temporary CA file for openssl with the trusted issuer of server in Url, using intermediate certificates provided by server tls and trusted CACert.pem file Cache lifetime is 1 hour. This is to speed up openssl 3 https connection when verify_cert is True. Openssl is very slow to process the whole cacert.pem file.

  Returns:

    str: path to cached ca file containing trusted cert

waptlicences.get_system_cabundle_path() → str

  Returns the path to CA certificates pem file. By default, use <wapt>/lib/site-packages/certifi/cacert.pem if it exists. Else, on windows, extract system ROOT+CA certificates and stores them

  > in file <localuserappdata>/.certifi/system-cacert.pem as Pem encoded data.

  On Linux, returns /etc/ssl/certs/ca-certificates.crt or /etc/pki/tls/certs/ca-bundle.crt

  Returns:

    str: full path to the Pem file

waptlicences.get_template_filenames(base_template_names: List[str], application_name: str = None, subdir: str = None, only_existing: bool = False) → List[str]

waptlicences.get_wapt_base_dir() → str

waptlicences.get_wapt_configfilename() → str

waptlicences.has_rebooted(last_bootup_time: int) → bool

  Returns True if system has rebooted, ie supplied last_bootup_time is different from current one for more than 5 secs

waptlicences.install_json_config(json_config_data: str, config_name: str = None, priority: int = None) → str

  install the json config file and embedded certificates

waptlicences.install_json_config_certificates(json_config_data: str, config_name: str = None, authorized_certs_dir: str = None) → List[str]

waptlicences.is_enterprise()

  force_check:bool -> bool. Return True if there is a valid licence.

waptlicences.is_safe_filename(s: str) → bool

waptlicences.is_waiting_for_reboot() → List

  Returns List of reasons if system needs reboot. Empty List if reboot is not needed

waptlicences.kb(size: int, nospace: bool = false) → str

  Convert a size to a human readable value

waptlicences.libpython_path()

  Path to Python runtime Dll/Module loaded by python module

waptlicences.licencing_status()

  force_check:bool -> bool. Return a dict with current licencing status after calling “check_valid_licences_count”.

waptlicences.list_taskbar_pins() → List[Tuple[str, str]]

  Returns a list of the taskbar pinned items. Each element is a 2 strings tuples containing (in order) the display name of the pin and its link path.

waptlicences.listen_oidc_code_state(port: int = 8095, timeout: int = 60) → Dict[str, str]

  Starts a http server on loopback to listen for OpenID connect code and state id

waptlicences.localpeercache_args(url: str, hash: str, ca_certificate_file, certificate_file, private_key_file, ignore_certificate_errors: bool = True, http_proxy: str = None, bearer_token: str = None) → Dict

  Get Local URL and bearer token to trigger download of file pointed by url And set downloader ca and ssl auth for peercache download. Returns

  > Dict[str,str] of kind {“direct_uri”:”http://192.168.100.50:8099/https/wapt.domain.local/waptwua/wsusscn2.cab”,”direct_bearer”:”Authorization: Bearer …”}

waptlicences.make_monotonic_id(appid: int = 100) → int

waptlicences.make_valid_package_name(s: str) → str

waptlicences.peercache_free()

waptlicences.peercache_init(host_uuid, inifilename, secret, interface_name: str) → bool

waptlicences.peercache_set_secret(secret: str)

waptlicences.peercache_start() → bool

waptlicences.peercache_status() → dict

waptlicences.pin_to_taskbar(program_path: str) → None

  Pin a program to the taskbar (windows only)

waptlicences.power_manage_request(reason: str, request_type: int) → PyPowerRequest

  block screen or suspend until result is released

waptlicences.random_ident(plen: int = 64) → str

waptlicences.random_password(plen: int = 64) → str

waptlicences.remove_accents(s: str) → str

waptlicences.remove_json_config(config_name: str = None) → str

  remove the json config file and associated certificates

waptlicences.render_mustache(template: str, data: dict, escape_for_html: bool = True, application_name: str = None) → str

waptlicences.rsa_decrypt(data: bytes, rsakeypem: bytes, password: bytes = None) → bytes

  Decrypt data with private key and returns clear text data

waptlicences.rsa_encrypt(data: bytes, certpem: bytes) → bytes

  Returns encrypted data with public key in X509 certificate

waptlicences.rsa_sign(rsakeypem: bytes, password: bytes, data: bytes) → bytes

  return base64encoded sha256 RSA signature of data

waptlicences.rsa_verify(data: bytes, signature: bytes, certpem: bytes) → bool

  Verify a base64 encoded signature against data and public key in X509 certificate

waptlicences.serialize_for_signature()

  Returns json serialized data from json data

waptlicences.set_wapt_base_dir(adir: str)

waptlicences.set_wapt_configfilename(adir: str)

waptlicences.set_wget_audit_callback(callback: Callable[[source_type, source, url:str, total_downloaded, startime, endtime: int], None]) → None

waptlicences.sign_json_data()

  json_data:str, key_pem:str, key_pwd: str, cert_pem: str -> bool

waptlicences.sign_package(package_filename, certificate_path, private_key_path, keypassword, keep_signature_date, excludes_full, excludes) → str

waptlicences.snakecase(s: str) → str

waptlicences.stuff_exe_certificate()

  filename:str, data:bytes -> boolean

waptlicences.sys_argv()

  sys.argv arguments as seen by python module

waptlicences.sys_path()

  sys.path in module

waptlicences.system_infos_summary() → Dict

  Returns current system metrics. cpu, mem, user, host, disk

waptlicences.sz_extract_all(file_to_extract: str, target: str = ', sz_dll_path: str=') → None

  Extract all from a compressed file (windows only)

waptlicences.totp_build_register_url()

  totp_build_register_url(issuer: str, account_name: str, secret:str): str

waptlicences.totp_calculate()

  totp_calculate(secret: str, counter: int = -1): int

waptlicences.totp_generate_secret()

  totp_generate_secret(secret_len: int = 20): str

waptlicences.totp_validate()

  totp_validate(secret: str, token: int = -1, window_size=1, timestamp=-1): bool

waptlicences.unpin_from_taskbar(program_path: str) → None

  Unpin a program from the taskbar (windows only)

waptlicences.unzip()

  unzip(zipfn: str, target: Optional[str] = None, filenames: List[str] = None, extract_with_full_paths: bool = True): List[str] Unzip file

waptlicences.uptime()

  uptime -> integer Returns system uptime in seconds

waptlicences.verify_json_data()

  json_data:str, cert_pem:str -> boolean

waptlicences.wapt_local_json_get(action:str, authtoken=', user=', password=', timeoutms:int =-1, data:str=None) → dict

waptlicences.wapt_local_login(user, password: str, timeoutms: int = -1) → str

waptlicences.waptjsondumps(data: [dict, list]) → str

waptlicences.waptjsonloads(json: str) → [dict, list]

waptlicences.waptserver_login(config_filename: str, user: str, password: str = None, cert: tuple = None, login_token: str = None, get_token: bool = False, get_acls: bool = False, otp_code: str = None) → dict

waptlicences.waptserver_logout(config_filename: str) → bool

waptlicences.waptserver_request(config_filename, action: str, method: str = 'GET', data: str = None, auth_context: dict = None, user: str = None, password: str = None, try_kerberos: bool = False, additional_headers: str = None, use_ssl_auth: bool = True, token: str = None) → dict

waptlicences.waptwget(url:str, target:str=None, http_proxy=None, connect_timeout:int=10, download_timeout:int=None, verify_cert:str=None, cert:list=None, resume:bool=True, hashhexa:str=None, cache_dir:str=None, limit_bandwidth:int=None, use_peer_cache:bool=True, progress_callback:[Callable[[received:int, total:int, speed, url:str],bool]]=None, stats: list=None, bearer_token:str=None, try_local_peercache: bool=False ) → str

waptlicences.wmi_get(wmi_class: str, filter: Dict[str, Any] = None, namespace: str = 'root\\CIMV2') → Dict

  Get WMI an object using {k=v} query.

waptlicences.wmi_query(wmi_class: str, property_names: List[str] = None, query: str = None, namespace: str = 'root\\CIMV2') → List[Dict]

  Query WMI class using query.

waptlicences.x509_fingerprint(pem: bytes, md: str = 'sha1') → str

  returns hex encoded X509 certificate fingerprint for message digest md (sha1, sha256)

# waptguihelpers

GUI Helpers for wapt build password dialog

waptguihelper.build_params_dialog(title: str, configpath, server_url, user, password, keypath, keypassword, description) → Dict

  Dialog which asks for user, password and key password for package build / upload.

waptguihelper.combo_dialog()

  Dialog to choose an option. Parameters: - Title: the title for the dialog - Text: indicates which value the user should type - List: a string list Optional: - StayOnTop: indicates if the form will always stay on top - default is False - RaiseError: indicates that it will raise an error, if user do not response/choose - default is False - TimeOut: indicates that will auto-close the form in X seconds - default is 0 (no timeout)

waptguihelper.directory_dialog()

  Dialog to choose a directory. Parameters: - Title: the title for the dialog Optional: - InitialDir: initial directory path

waptguihelper.filename_dialog()

  Dialog to choose a filename. Parameters: - Title: the title for the dialog Optional: - InitialDir: initial directory path - default is last location - FileName: default file name - Filter: filter by description and extension, eg: “ISO Files|*.iso”

waptguihelper.grid_dialog()

  Dialog which shows an editable grid. Parameters: - Title: the title for the dialog - Data: a list or JSON string Optional: - ResultType: GRT_ALL or GRT_SELECTED - default is GRT_ALL - MetaData: it can be used to change columns data type

  > - it must be a JSON

  > - all types: String, Date, Time, DateTime, Integer, Float, Boolean, Memo

  > - example: {“columns”:[{“propertyname”:”id”,”datatype”:”Integer”}]}

  - Text: the label above search box - default is “Search”

  - StayOnTop: indicates if the form will always stay on top - default is False

  - RaiseError: indicates that it will raise an error, if user do not response/choose - default is False

  - TimeOut: indicates that will auto-close the form in X seconds - default is 0 (no timeout)

waptguihelper.gui_dllname()

  Dll used by waptguihelper

waptguihelper.gui_pythonpath()

  PythonPath as known by waptguihelper

waptguihelper.input_dialog()

  Dialog to type a value. Parameters: - Title: the title for the dialog - Text: indicates which value the user should type - Default: the default value, if the user do not want to type any Optional: - StayOnTop: indicates if the form will always stay on top - default is False - RaiseError: indicates that it will raise an error, if user do not response/choose - default is False - TimeOut: indicates that will auto-close the form in X seconds - default is 0 (no timeout)

waptguihelper.key_password_dialog(title, keypath, keypassword, raise_error, timeout, description) → Dict["keypassword":str]

  Dialog which asks for private key password.

waptguihelper.login_password_dialog(title:str="", server_url:str="", user:str="", password:"", raise_error:bool=False, timeout:int=0, show_otp:bool=False, confirm_password:bool=False, description:str="") → Dict[str, str]

  Dialog which asks for user and password. Optionaly show a description and a confirmation edit for password

waptguihelper.memo_dialog()

  Dialog to type a value. Parameters: - Title: the title for the dialog - Text: indicates which value the user should type - Default: the default value, if the user do not want to type any Optional: - StayOnTop: indicates if the form will always stay on top - default is False - RaiseError: indicates that it will raise an error, if user do not response/choose - default is False - TimeOut: indicates that will auto-close the form in X seconds - default is 0 (no timeout)

waptguihelper.message_dialog()

  Dialog which asks for user to take an action. Parameters: - title (str): The title to display in the message box. - text (str): The message text to display in the message box. - flags (int): Options for buttons and icons. You can combine a message and an icon by adding their corresponding integer values together.

  > Possible message options: - MB_OK (0): OK button - MB_OKCANCEL (1): OK and Cancel buttons - MB_ABORTRETRYIGNORE (2): Abort, Retry, and Ignore buttons - MB_YESNOCANCEL (3): Yes, No, and Cancel buttons - MB_YESNO (4): Yes and No buttons Possible icon options: - MB_ICONERROR (16): Error icon - MB_ICONQUESTION (32): Question icon - MB_ICONWARNING (48): Warning icon - MB_ICONINFORMATION (64): Information icon To combine a message and an icon, add their integer values together. For example, to display an OK button with an information icon, use:

  > > 0 + 64 (MB_OK + MB_ICONINFORMATION)

  > Returns: The response code indicating the user’s choice. Possible return values: - ID_OK (1) - ID_CANCEL (2) - ID_ABORT (3) - ID_RETRY (4) - ID_IGNORE (5) - ID_YES (6) - ID_NO (7)

waptguihelper.png_resize(filename: str, max_width, max_height: integer, target_filename: str=') → str

waptguihelper.set_loglevel()

  Set module loglevel. loglevel: str

- Tranquil IT