Start the TF browser

What the tf script does is the same as:

python -m tf.browser.start

During start up the following happens:

Load TF corpus data.

This can take a while. When it has loaded the data, it hands the TF API over to the web server.

Start TF web server

With the TF data in hand the TF web server is started.

Load web page

After a short while, the default web browser will be started with a URL and port at which the web server will listen. You see your browser being started up and the TF page being loaded.

Wait

The script now waits till the web server is finished. You finish it by pressing Ctrl-C, and if you have used the -d flag, you have to press it twice.

Additional arguments

You can direct the loading of corpus data by means of additional arguments, analogously to the use() command, documented in tf.about.usefunc.

The main argument specifies the data source in the same way as the first argument of the use() function:

• org/repo
• org/repo:specifier
• app:path/to/app
• data:path/to/data

The following arguments of the use() function can be used on the command-line, prepended with --:

• --checkout
• --relative
• --mod
• --set
• --locations
• --modules
• --version

The following argument does not come from the use() function:

• --tool

If you pass --tool=ner for example, the TF browser opens navigated to the ner tool page (named entity annotator).

Implementation notes

Different corpora will use different ports for web server.

The ports are computed from the org, repo and path arguments with which tf is called.

• Invocations of tf with different corpora lead to different ports
• Repeated invocations of tf with the same corpus lead to the same port, provided the previous invocation has been terminated.

Functions

def bMsg(url)

Expand source code Browse git

def bMsg(url):
    return f"\n\tOpen a webbrowser and navigate to url {url}\n"

def main(cargs=['--force', '--html', '--output-dir', 'site', '--template-dir', 'tf/docs/templates', 'tf'])

Expand source code Browse git

def main(cargs=sys.argv[1:]):
    console(BANNER)
    if len(cargs) >= 1 and any(
        arg in {"--help", "-help", "-h", "?", "-?"} for arg in cargs
    ):
        console(HELP)
        return
    if len(cargs) >= 1 and any(arg == "-v" for arg in cargs):
        return

    forceChrome = "--chrome" in cargs
    debug = "debug" in cargs
    cargs = [c for c in cargs if c not in {"debug", "--chrome"}]

    newCargs = []
    tool = None

    for x in cargs:
        if x.startswith("--tool="):
            tool = x[7:]
            if tool not in TOOLS:
                console(f'Unrecognized tool: "{tool}"')
                console(f"""Recognized tools are: {", ".join(sorted(TOOLS))}""")
                return
        else:
            newCargs.append(x)

    toolUrl = "" if tool is None else f"/{tool}/index"

    cargs = newCargs

    portWeb = getPort(argApp(cargs, True))
    noweb = argNoweb(cargs)
    url = f"{PROTOCOL}{HOST}:{portWeb}{toolUrl}"

    webapp = setup(debug, *cargs)

    if not webapp:
        return

    if noweb:
        console(bMsg(url))
        runWeb(webapp, debug, portWeb)
    else:
        p = Process(target=startBrowser, args=(url, forceChrome, debug))
        p.start()
        runWeb(webapp, debug, portWeb)

def startBrowser(url, forceChrome, debug)

Expand source code Browse git

def startBrowser(url, forceChrome, debug):
    opened = False
    new = 0
    autoraise = True

    sleep(1)
    runMain = os.environ.get("WERKZEUG_RUN_MAIN")

    if debug and runMain:
        console("browser has been opened when the initial process started")
        return

    if forceChrome:
        browser = "Chrome browser"
        try:
            console(f"trying {browser} ...")
            controller = webbrowser.get("chrome")
            opened = controller.open(url, new=new, autoraise=autoraise)
        except Exception:
            opened = False

        if opened:
            console(f"corpus opened in {browser}.")
        else:
            console(f"could not start {browser}!")

    if not opened:
        browser = "default browser"
        extra = " instead" if forceChrome else ""
        try:
            console(f"trying {browser}{extra} ...")
            opened = webbrowser.open(url, new=new, autoraise=autoraise)
        except Exception:
            opened = False

        if opened:
            console(f"corpus opened in {browser}{extra}.")
        else:
            console(f"could not start {browser}{extra}!")

    if not opened:
        console(bMsg(url))