pyserv package

Submodules

• pyserv.ext module
  • parse_cli_arguments()
• pyserv.server module
  • main()
  • serv_init()
  • serv_run()
• pyserv.settings module
  • get_user_iface()
  • get_user_iface_addr()
  • get_user_iface_mask()
  • get_userdirs()
  • init_dirs()
  • platform_check()
  • show_uservars()
• pyserv.tftpd module
  • main()
  • tftpd_init()
  • tftpd_run()
• pyserv.tui_helpers module
  • get_env()
  • get_log_lines()
  • get_w_env()
  • host_check()
  • tail()
• pyserv.wsgi module
  • main()
  • wsgi_init()
  • wsgi_run()

Module contents

Simple HTTP server classes with GET path rewriting and request/header logging. Now includes a reference WSGI server and tftpdaemon script.

class pyserv.GetHandler(*args, directory=None, **kwargs)

Bases: SimpleHTTPRequestHandler

Munge the incoming request path from Dialog OTA. Runs urlparse on the url and updates the GET handler path. We also log the result.

do_GET()

Serve a GET request.

log_message(format, *args)

We need a custom log handler, otherwise Get message goes to sys.stdout only.

class pyserv.GetServer(iface, port, directory='.')

Bases: Thread

Threaded wrapper class for custom ThreadingHTTPServer instance.

Usage:

s = GetServer('', 8080)
s.start()
s.stop()

run()

Start main server thread

stop()

Stop main server thread

class pyserv.GetServerWSGI(flask_app, port, is_flask=False, validate=False)

Bases: Thread

Threaded wrapper class for custom flask WSGIServer instance.

Usage:

s = GetServerWSGI(my_app, 8080, is_flask=True, validate=False)
s.start()
s.stop()

run()

Start main server thread

stop()

Stop main server thread

class pyserv.RepeatTimer(interval, function, *args, **kwargs)

Bases: object

A non-blocking timer thread to execute a user func repeatedly. Usage:

def hello(name):
    print(f"Hello {name}")

rt = RepeatTimer(1, hello, "World")  # it auto-starts
try:
    sleep(5)  # run other stuff
finally:
    rt.stop()  # best in a try/finally block

Author: https://stackoverflow.com/a/38317060/14874218

Parameters:

• interval (int | float)

• function (Callable)

start()

Safely (re)start thread timer.

stop()

Safely stop thread timer.

pyserv.munge_url(ota_url)

Parse the url sent by OTA command for file path and host string.

Parameters:

ota_url – (possibly) broken GET path

Return tuple:

netloc and path from urlparse