panel.command Package

---

command Package

Commandline interface to Panel

panel.command.main(args=None)

Mirrors bokeh CLI and adds additional Panel specific commands

panel.command.transform_cmds(argv)

Allows usage with anaconda-project by remapping the argv list provided into arguments accepted by Bokeh 0.12.7 or later.

---

bundle Module

class panel.command.bundle.Bundle(parser: ArgumentParser)

Bases: Subcommand

Subcommand to generate a new encryption key.

invoke(args)

Takes over main program flow to perform the subcommand.

This method must be implemented by subclasses. subclassed overwritten methods return different types: bool: Build None: FileOutput (subclassed by HTML, SVG and JSON. PNG overwrites FileOutput.invoke method), Info, Init, Sampledata, Secret, Serve, Static

Parameters:

args (argparse.Namespace) – command line arguments for the subcommand to parse

Raises:

NotImplementedError –

name: ClassVar[str] = 'bundle'

name for this subcommand

---

convert Module

class panel.command.convert.Convert(parser: ArgumentParser)

Bases: Subcommand

Subcommand to convert Panel application to some build target, e.g. pyodide or pyscript.

invoke(args: Namespace) → None

Takes over main program flow to perform the subcommand.

This method must be implemented by subclasses. subclassed overwritten methods return different types: bool: Build None: FileOutput (subclassed by HTML, SVG and JSON. PNG overwrites FileOutput.invoke method), Info, Init, Sampledata, Secret, Serve, Static

Parameters:

args (argparse.Namespace) – command line arguments for the subcommand to parse

Raises:

NotImplementedError –

name: ClassVar[str] = 'convert'

name for this subcommand

---

oauth_secret Module

class panel.command.oauth_secret.OAuthSecret(parser: ArgumentParser)

Bases: Subcommand

Subcommand to generate a new encryption key.

invoke(args)

Takes over main program flow to perform the subcommand.

This method must be implemented by subclasses. subclassed overwritten methods return different types: bool: Build None: FileOutput (subclassed by HTML, SVG and JSON. PNG overwrites FileOutput.invoke method), Info, Init, Sampledata, Secret, Serve, Static

Parameters:

args (argparse.Namespace) – command line arguments for the subcommand to parse

Raises:

NotImplementedError –

name: ClassVar[str] = 'oauth-secret'

name for this subcommand

---

serve Module

Subclasses the bokeh serve commandline handler to extend it in various ways.

class panel.command.serve.AdminApplicationContext(application, unused_timeout=15000, **kwargs)

Bases: ApplicationContext

class panel.command.serve.Serve(parser: ArgumentParser)

Bases: Serve

customize_applications(args, applications)

Allows subclasses to customize applications.

Should modify and return a copy of the applications dictionary.

customize_kwargs(args, server_kwargs)

Allows subclasses to customize server_kwargs.

Should modify and return a copy of the server_kwargs dictionary.

customize_server(server: Server) → Server

Allows subclasses to customize the server.

Should apply modifications to the server and wrap it or return the same instance.

invoke(args)

name: ClassVar[str] = 'serve'

name for this subcommand

panel.command.serve.parse_var(s)

Parse a key, value pair, separated by ‘=’ That’s the reverse of ShellArgs.

On the command line (argparse) a declaration will typically look like:

foo=hello

or

foo=”hello world”

panel.command.serve.parse_vars(items)

Parse a series of key-value pairs and return a dictionary

---