peek_plugin_base.server package¶
Submodules¶
peek_plugin_base.server.PeekPlatformAdminHttpHookABC module¶
-
class
peek_plugin_base.server.PeekPlatformAdminHttpHookABC.
PeekPlatformAdminHttpHookABC
[source]¶ Bases:
object
Peek Platform Site HTTP Hook
The methods provided by this class apply to the HTTP sites served by the Client service for the mobile and desktop apps, and the Server service for the admin app.
It is not the HTTP service that provides resources (vortex, etc) beween the server and the agent, worker and client.
-
addAdminResource
(pluginSubPath: bytes, resource: txhttputil.site.BasicResource.BasicResource) → None[source]¶ Add Site Resource
Add a cusotom implementation of a served http resource.
- Parameters
pluginSubPath – The resource path where you want to serve this resource.
resource – The resource to serve.
- Returns
None
-
addAdminStaticResourceDir
(dir: str) → None[source]¶ Add Site Static Resource Directory
Calling this method sets up directory
dir
to be served by the site.- Parameters
dir – The file system directory to be served.
- Returns
None
-
property
rootAdminResource
¶ Site Root Resource
This returns the root site resource for this plugin.
-
peek_plugin_base.server.PeekPlatformServerHttpHookABC module¶
-
class
peek_plugin_base.server.PeekPlatformServerHttpHookABC.
PeekPlatformServerHttpHookABC
[source]¶ Bases:
object
Peek Platform Server HTTP Hook
The methods provided by this class apply to the HTTP service that provides resources (vortex, etc) beween the server and the agent, worker and client.
These resources will not be availible to the web apps.
-
addServerResource
(pluginSubPath: bytes, resource: txhttputil.site.BasicResource.BasicResource) → None[source]¶ Add Server Resource
Add a cusotom implementation of a served http resource.
- Parameters
pluginSubPath – The resource path where you want to serve this resource.
resource – The resource to serve.
- Returns
None
-
addServerStaticResourceDir
(dir: str) → None[source]¶ Add Server Static Resource Directory
Calling this method sets up directory
dir
to be served by the site.- Parameters
dir – The file system directory to be served.
- Returns
None
-
property
rootServerResource
¶ Server Root Resource
This returns the root site resource for this plugin.
-
peek_plugin_base.server.PeekServerPlatformHookABC module¶
-
class
peek_plugin_base.server.PeekServerPlatformHookABC.
PeekServerPlatformHookABC
[source]¶ Bases:
peek_plugin_base.PeekPlatformCommonHookABC.PeekPlatformCommonHookABC
,peek_plugin_base.server.PeekPlatformAdminHttpHookABC.PeekPlatformAdminHttpHookABC
,peek_plugin_base.server.PeekPlatformServerHttpHookABC.PeekPlatformServerHttpHookABC
,peek_plugin_base.PeekPlatformFileStorageHookABC.PeekPlatformFileStorageHookABC
-
abstract property
dbConnectString
¶ DB Connect String
- Returns
The SQLAlchemy database engine connection string/url.
-
abstract property
dbEngineArgs
¶ DB Engine Args
- Returns
The SQLAlchemy database engine arguments.
-
abstract property
peek_plugin_base.server.PluginLogicEntryHookABC module¶
peek_plugin_base.server.PluginLogicEntryHookInheritenceTest module¶
-
class
peek_plugin_base.server.PluginLogicEntryHookInheritenceTest.
MyABC
[source]¶ Bases:
object
-
abstract property
propA
¶
-
abstract property
-
class
peek_plugin_base.server.PluginLogicEntryHookInheritenceTest.
MyClass
[source]¶ Bases:
peek_plugin_base.server.PluginLogicEntryHookInheritenceTest.MyABC
,peek_plugin_base.server.PluginLogicEntryHookInheritenceTest.MyMixin
-
property
propA
¶
-
property
propB
¶
-
property
-
class
peek_plugin_base.server.PluginLogicEntryHookInheritenceTest.
MyClassNoPropA
[source]¶ Bases:
peek_plugin_base.server.PluginLogicEntryHookInheritenceTest.MyABC
,peek_plugin_base.server.PluginLogicEntryHookInheritenceTest.MyMixin
-
property
propB
¶
-
property
-
class
peek_plugin_base.server.PluginLogicEntryHookInheritenceTest.
MyClassNoPropB
[source]¶ Bases:
peek_plugin_base.server.PluginLogicEntryHookInheritenceTest.MyABC
,peek_plugin_base.server.PluginLogicEntryHookInheritenceTest.MyMixin
-
property
propA
¶
-
property
-
class
peek_plugin_base.server.PluginLogicEntryHookInheritenceTest.
MyMixin
[source]¶ Bases:
object
-
abstract property
propB
¶
-
abstract property
-
class
peek_plugin_base.server.PluginLogicEntryHookInheritenceTest.
PluginLogicEntryHookInheritenceTest
(methodName='runTest')[source]¶ Bases:
unittest.case.TestCase
Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.