Functions — github.com/YunoHost/yunohost

hub / github.com/YunoHost/yunohost / functions

Functions1,520 in github.com/YunoHost/yunohost

⨍ Functions 1,520◇ Types & classes 170↳ Endpoints 32

↓ 417 callersMethodget

(self, attr: str, default: Any = None)

src/utils/form.py:2023

↓ 394 callersMethodn

(self)

src/utils/resources.py:1662

↓ 140 callersMethoderror

Declare the failure of the unit operation

src/log.py:853

↓ 82 callersFunctionapp_setting

Set or get an app setting value Keyword argument: value -- Value to set app -- App ID key -- Key to get/set

src/app.py:1833

↓ 77 callersMethodinfo

(Getter) Dict containing info about the archive being created

src/backup.py:316

↓ 75 callersFunctionuser_permission_list

List permissions and corresponding accesses

src/permission.py:84

↓ 74 callersMethodformat

(self, record)

src/log.py:559

↓ 74 callersFunctionmessage

(key, **kwargs)

tests/conftest.py:52

↓ 65 callersMethodsuccess

Declare the success end of the unit operation

src/log.py:847

↓ 63 callersMethodnormalize

( value: list[str] | str | None, option: Union["BaseOption", dict[Any, Any]] = {} )

src/utils/form.py:1600

↓ 62 callersFunctioncheck_output

Run command with arguments and return its output as a byte string Overwrite some of the arguments to capture standard error in the result and

src/utils/process.py:32

↓ 51 callersMethodupdate

Modify LDAP entry Keyword arguments: rdn -- DN without domain attr_dict -- Dictionnary of attribut

src/utils/ldap.py:304

↓ 50 callersFunctionread_file

Read a regular text file Keyword argument: file_path -- Path to the text file

src/utils/file_utils.py:39

↓ 47 callersMethoddecode

(value: str | bytes)

src/utils/ldap.py:233

↓ 47 callersFunctiondomain_list

List domains Keyword argument: exclude_subdomains -- Filter out domains that are subdomains of other declared domains tree -

src/domain.py:155

↓ 42 callersMethodstart

Start to record logs that change the system Until this start method is run, no unit operation will be registered.

src/log.py:704

↓ 41 callersMethodremove

Remove LDAP entry Keyword arguments: rdn -- DN without domain Returns: Boolean | Moulinette

src/utils/ldap.py:281

↓ 40 callersMethodsearch

Search in LDAP base Perform an LDAP search operation with given arguments and return results as a list. Keyword arguments:

src/utils/ldap.py:189

↓ 39 callersFunctionraiseYunohostError

(mocker, key, **kwargs)

tests/conftest.py:64

↓ 36 callersFunctionmkdir

Create a directory with optional features Create a directory and optionaly set its permissions to mode and its owner and/or group. If path re

src/utils/file_utils.py:256

↓ 36 callersMethodwrite

(self)

src/firewall.py:97

↓ 35 callersFunctionall_fails

Returns a series of params for which output is expected to be failing with validation error

tests/test_questions.py:359

↓ 34 callersFunctionrm

Remove a file or directory Keyword arguments: - path -- The path to remove - recursive -- Remove directories and their contents r

src/utils/file_utils.py:385

↓ 32 callersFunction_get_maindomain

()

src/domain.py:78

↓ 32 callersFunction_is_app_repo_url

(string: str)

src/utils/app_utils.py:603

↓ 31 callersFunctionget_test_apps_dir

()

tests/conftest.py:46

↓ 30 callersFunction_get_ldap_interface

()

src/utils/ldap.py:43

↓ 30 callersFunctionsettings_get

Get an entry value in the settings Keyword argument: key -- Settings key

src/settings.py:56

↓ 29 callersMethodcopy

(self, file, target)

src/backup.py:2009

↓ 29 callersMethodread

The config is expected to have a structure as below See also conf/yunohost/firewall.yml tcp: 123:

src/firewall.py:67

↓ 29 callersFunctionregen_conf

Regenerate the configuration file(s) Keyword argument: names -- Categories to regenerate configuration of with_diff -- Show

src/regenconf.py:55

↓ 29 callersFunctionrequest

(webpath, logged_as=None, session=None, inject_auth=None, logged_on=None)

tests/test_sso_and_portalapi.py:135

↓ 28 callersFunctionapp_ssowatconf

Regenerate SSOwat configuration file

src/app.py:1990

↓ 28 callersMethodprovision_or_update

(self, context)

tests/test_app_resources.py:48

↓ 27 callersFunction_is_installed

(app: str)

src/utils/app_utils.py:882

↓ 27 callersFunctionapp_remove

Remove app Keyword arguments: app -- App(s) to delete purge -- Remove with all app data force_workdir -- Special var

src/app.py:1690

↓ 27 callersFunctionchown

Change the owner and/or group of a path Keyword arguments: - uid -- Numeric uid or user name - gid -- Numeric gid or group name

src/utils/file_utils.py:310

↓ 27 callersFunctionhook_callback

Execute all scripts binded to an action Keyword argument: action -- Action name hooks -- List of hooks names to execute

src/hook.py:224

↓ 26 callersFunctionbackup_list

List available local backup archives Keyword arguments: with_info -- Show backup information for each archive human_readable

src/backup.py:2293

↓ 26 callersFunctionuser_group_list

List groups Keyword argument: full -- List all the info available for each groups include_primary_groups -- Include groups c

src/user.py:1039

↓ 25 callersFunction_get_app_settings

Get settings of an installed app Keyword arguments: app -- The app id (like nextcloud__2)

src/utils/app_utils.py:112

↓ 25 callersFunctionwrite_to_file

Write a single string or a list of string to a text file. The text file will be overwritten by default. Keyword argument: file_p

src/utils/file_utils.py:130

↓ 24 callersFunctionuser_list

(fields: list[str] | None = None)

src/user.py:79

↓ 24 callersFunctionuser_permission_update

Allow or Disallow a user or group to a permission for a specific application Keyword argument: permission -- Name of the permiss

src/permission.py:199

↓ 22 callersFunctionchmod

Change the mode of a path Keyword arguments: - mode -- Numeric path mode to set - fmode -- Numeric file mode to set in case of a

src/utils/file_utils.py:359

↓ 22 callersMethodget_setting

(self, key)

src/utils/resources.py:216

↓ 22 callersFunctionuser_group_update

( operation_logger: "OperationLogger", groupname: str, add: None | str | list[str] = None, rem

src/user.py:1222

↓ 21 callersFunctiondomain_add

Create a custom domain Keyword argument: domain -- Domain name to add dyndns -- Subscribe to DynDNS dyndns_recovery_

src/domain.py:274

↓ 21 callersFunctionread_yaml

Safely read a yaml file Keyword argument: file -- Path or stream to the yaml file

src/utils/file_utils.py:89

↓ 20 callersFunction_installed_apps

()

src/utils/app_utils.py:894

↓ 20 callersFunction_sync_permissions_with_ldap

Sychronize the 'memberUid' / 'inheritPermission' attributes in the ldap permission object according to the group members and permission "allo

src/permission.py:616

↓ 20 callersFunctionapp_install

Install apps Keyword argument: app -- Name, local path or git URL of the app to install label -- Custom name for the app

src/app.py:1320

↓ 20 callersFunctionnones

Returns common scenarios for ~None values. - required and required + as default -> `FAIL` - optional and optional + as default -> `expect

tests/test_questions.py:317

↓ 19 callersFunction_validate_and_sanitize_permission_url

Check and normalize the urls passed for all permissions Also check that the Regex is valid As documented in the 'ynh_permission_create'

src/permission.py:932

↓ 19 callersMethodadd

Add LDAP entry Keyword arguments: rdn -- DN without domain attr_dict -- Dictionnary of attributes/

src/utils/ldap.py:247

↓ 19 callersFunctionpermission_url

Update urls related to a permission for a specific application Keyword argument: permission -- Name of the permission (e.g. mail or

src/permission.py:460

↓ 19 callersFunctionservice_status

Show status information about one or more services (all by default) Keyword argument: names -- Services name to show

src/service.py:349

↓ 18 callersFunction_assert_domain_exists

(domain: str)

src/domain.py:249

↓ 18 callersFunctionall_as

Returns a series of params for which output is expected to be the same single value Example:: # expect all values to output as `True

tests/test_questions.py:348

↓ 18 callersMethodcontent

(self)

src/utils/error.py:57

↓ 18 callersFunctionsettings_set

Set an entry value in the settings Keyword argument: key -- Settings key value -- New value

src/settings.py:94

↓ 17 callersFunction_get_dns_zone_for_domain

Get the DNS zone of a domain Keyword arguments: domain -- The domain name

src/dns.py:365

↓ 17 callersFunctionapp_config_get

Display an app configuration in classic, full or export mode

src/app.py:2262

↓ 17 callersMethoddelete_setting

(self, key)

src/utils/resources.py:226

↓ 17 callersMethodset_result

Change (or initialize) the current status/result of a given target. Args: category -- The category of the target

src/backup.py:106

↓ 17 callersFunctionuser_create

( operation_logger: "OperationLogger", username: str, domain: str, password: str, fullname

src/user.py:167

↓ 16 callersFunction_get_conf_hashes

Get the registered conf hashes for a category

src/regenconf.py:600

↓ 16 callersFunctionapp_is_not_installed

(domain, app)

tests/test_apps.py:145

↓ 16 callersFunctionapp_upgrade

Upgrade app Keyword argument: app -- App(s) to upgrade (default all) url -- Git url to fetch for upgrade file -- Fol

src/app.py:713

↓ 16 callersMethodapply

(self, upnp: bool = True)

src/firewall.py:181

↓ 16 callersFunctiondomain_remove

Delete domains Keyword argument: domain -- Domain to delete remove_apps -- Remove applications installed on the domain

src/domain.py:428

↓ 16 callersMethodparse

(drive: dict)

src/disk.py:39

↓ 16 callersFunctionread_json

Read a json file Keyword argument: file_path -- Path to the json file

src/utils/file_utils.py:69

↓ 15 callersFunction_get_services

Get a dict of managed services with their parameters

src/service.py:677

↓ 15 callersFunctionask_questions_and_parse_answers

Parse arguments store in either manifest.json or actions.json or from a config panel against the user answers when they are present. Keyword

src/utils/form.py:2263

↓ 15 callersFunctionbackup_create

Create a backup local archive Keyword arguments: name -- Name of the backup archive description -- Short description of the

src/backup.py:2103

↓ 15 callersFunctioncall_async_output

Run command and provide its output asynchronously Run command with arguments and wait for it to complete to return the returncode attribute.

src/utils/process.py:46

↓ 15 callersMethodhumanize

( value: str | list[str] | None, option: Union["BaseOption", dict[Any, Any]] = {} )

src/utils/form.py:1590

↓ 14 callersFunction_permission_create_with_dummy_app

( permission, allowed=None, url=None, additional_urls=None, auth_header=True, show_til

tests/test_permission.py:70

↓ 14 callersMethod_run_script

(self, action, script, env={})

src/utils/resources.py:251

↓ 14 callersFunctionbackup_restore

Restore from a local backup archive Keyword argument: name -- Name of the local backup archive force -- Force restauration o

src/backup.py:2219

↓ 14 callersMethodget_cached_report

(id_, item=None, warn_if_no_cache=True)

src/diagnosis.py:527

↓ 14 callersFunctioninstall_legacy_app

(domain, path, public=True)

tests/test_apps.py:164

↓ 14 callersMethodlist

List targets in a given category. The list is filtered with a whitelist (include) or blacklist (exclude) with respect to the

src/backup.py:191

↓ 14 callersMethodprompt

(self, *args, **kwargs)

tests/conftest.py:110

↓ 14 callersFunctionrandom_ascii

Return a random ascii string

src/utils/misc.py:23

↓ 14 callersMethodset_setting

(self, key, value)

src/utils/resources.py:221

↓ 14 callersFunctionunchanged

Returns a series of params for which output is expected to be the same as its intake Example:: # expect `"value"` to output as `"val

tests/test_questions.py:336

↓ 14 callersFunctionwrite_to_yaml

Write a dictionnary or a list to a yaml file Keyword argument: file_path -- Path to the output yaml file data -- The data to

src/utils/file_utils.py:232

↓ 13 callersFunction_assert_is_installed

(app: str)

src/utils/app_utils.py:886

↓ 13 callersFunction_make_environment_for_app_script

( app, args={}, args_prefix="APP_ARG_", workdir=None, action=None, force_include_app_s

src/utils/app_utils.py:1176

↓ 13 callersFunctioncan_access_webpage

(webpath, logged_as=None)

tests/test_permission.py:344

↓ 13 callersMethoddeprovision

(self, context)

tests/test_app_resources.py:54

↓ 13 callersFunctionmanually_modified_files

()

src/regenconf.py:724

↓ 13 callersFunctionwrite_to_json

Write a dictionnary or a list to a json file Keyword argument: file_path -- Path to the output json file data -- The data to

src/utils/file_utils.py:188

↓ 13 callersFunctionxpass

Return a pytest param for which test should have fail but currently passes.

tests/test_questions.py:368

↓ 12 callersFunction_get_manifest_of_app

(path_or_app_id: str)

src/utils/app_utils.py:219

↓ 12 callersFunction_ldap_path_extract

(path: str, info: str)

src/utils/ldap.py:64

↓ 12 callersFunction_value_for_locale

Return proper value for current locale Keyword arguments: values -- A dict of values associated to their locale Returns:

src/utils/i18n.py:24

↓ 12 callersMethodrun

(self)

src/tools.py:1120

next →1–100 of 1,520, ranked by callers