core

iii

iii

iii

vvv iii uu uu rrrrrrrr

vvvv iii uu uu rr rr

v vvvv iii uu uu rr rr vv vvvv iii uu uu rr rrrrr

vvvv vvvv iii uu uu rr rrr

vvv vvvv iii uu uu rr rrr

vvvvvv iii uu uu rr rrr

vvvv iii uuuuuu rr rrr

I N F O R M A T I O N S Y S T E M

viur-core Copyright © 2012-2024 by Mausbrand Informationssysteme GmbH

ViUR is a free software development framework for the Google App Engine™. More about ViUR can be found at https://www.viur.dev.

Licensed under the GNU Lesser General Public License, version 3. See file LICENSE for more information.

Subpackages

• core.bones
  • core.bones.base
  • core.bones.boolean
  • core.bones.captcha
  • core.bones.color
  • core.bones.credential
  • core.bones.date
  • core.bones.email
  • core.bones.file
  • core.bones.json
  • core.bones.key
  • core.bones.numeric
  • core.bones.password
  • core.bones.randomslice
  • core.bones.raw
  • core.bones.record
  • core.bones.relational
  • core.bones.select
  • core.bones.selectcountry
  • core.bones.sortindex
  • core.bones.spatial
  • core.bones.string
  • core.bones.text
  • core.bones.treeleaf
  • core.bones.treenode
  • core.bones.user
• core.languages
  • core.languages.de
  • core.languages.en
• core.modules
  • core.modules.file
  • core.modules.formmailer
  • core.modules.moduleconf
  • core.modules.page
  • core.modules.script
  • core.modules.site
  • core.modules.user
• core.prototypes
  • core.prototypes.list
  • core.prototypes.singleton
  • core.prototypes.skelmodule
  • core.prototypes.tree
• core.render
  • core.render.html
    • core.render.html.env
    • core.render.html.default
    • core.render.html.user
    • core.render.html.utils
  • core.render.json
    • core.render.json.default
    • core.render.json.user
  • core.render.vi
    • core.render.vi.user
  • core.render.xml
    • core.render.xml.default
    • core.render.xml.user

Submodules

• core.cache
• core.config
• core.current
• core.db
• core.decorators
• core.email
• core.errors
• core.i18n
• core.logging
• core.module
• core.pagination
• core.ratelimit
• core.request
• core.secret
• core.securityheaders
• core.securitykey
• core.session
• core.skeleton
• core.tasks
• core.utils
• core.version

Package Contents

Functions

load_indexes_from_file()	Loads all indexes from the index.yaml and stores it in a dictionary sorted by the module(kind)
setDefaultLanguage(lang)	Sets the default language used by ViUR to lang.
setDefaultDomainLanguage(domain, lang)	If conf["viur.languageMethod"] is set to "domain", this function allows setting the map of which domain
buildApp(modules, renderers[, default])	Creates the application-context for the current instance.
setup(modules[, render, default])	Define whats going to be served by this instance.
app(environ, start_response)
__getattr__(attr)

Attributes

__DEPRECATED_DECORATORS

core.load_indexes_from_file()

Loads all indexes from the index.yaml and stores it in a dictionary sorted by the module(kind) :return A dictionary of indexes per module

Return type:

Dict[str, List]

core.setDefaultLanguage(lang)

Sets the default language used by ViUR to lang.

Parameters:

lang (str) – Name of the language module to use by default.

core.setDefaultDomainLanguage(domain, lang)

If conf[“viur.languageMethod”] is set to “domain”, this function allows setting the map of which domain should use which language. :param domain: The domain for which the language should be set :param lang: The language to use (in ISO2 format, e.g. “DE”)

Parameters:

• domain (str) –

• lang (str) –

core.buildApp(modules, renderers, default=None)

Creates the application-context for the current instance.

This function converts the classes found in the modules-module, and the given renders into the object found at conf["viur.mainApp"].

Every class found in modules becomes

• instanced

• get the corresponding renderer attached

• will be attached to conf["viur.mainApp"]

Parameters:

• modules (Union[types.ModuleType, object]) – Usually the module provided as modules directory within the application.

• renderers (Union[types.ModuleType, Dict]) – Usually the module viur.core.renders, or a dictionary renderName => renderClass.

• default (str) – Name of the renderer, which will form the root of the application. This will be the renderer, which wont get a prefix, usually html. (=> /user instead of /html/user)

core.setup(modules, render=None, default='html')

Define whats going to be served by this instance.

Parameters:

• modules (Union[object, types.ModuleType]) – Usually the module provided as modules directory within the application.

• render (Union[types.ModuleType, Dict]) – Usually the module viur.core.renders, or a dictionary renderName => renderClass.

• default (str) – Name of the renderer, which will form the root of the application. This will be the renderer, which wont get a prefix, usually html. (=> /user instead of /html/user)

core.app(environ, start_response)

Parameters:

• environ (dict) –

• start_response (Callable) –

core.__DEPRECATED_DECORATORS

core.__getattr__(attr)

Parameters:

attr (str) –

Return type:

object