Nihonium

logEntry(entry, timestamp)

• entry (str): The message you want to make an entry for. Required.
• timestamp (

  datetime.datetime

  ): The timestamp for the entry. Defaults to

  datetime.datetime.now()

  .
• When forking, it's recommended you keep this function.

Creates an entry in the logfiles.

getReq(*args, **kwargs)

• args, kwargs (varies): The arguments you want to pass to

  mainSession.get()

  .

Makes a GET request, stores the received cookies, and makes a log entry.

postReq(*args, **kwargs)

• args, kwargs (varies): The arguments you want to pass to

  mainSession.post()

  .

Makes a POST request, stores the received cookies, and makes a log entry.

update_sig(_motd, xline, misc)

• _motd (function, takes no inputs): A function used to generate a motd (message of the day).
• xline (bool): Whether to mark the bot as online or offline.
• misc (str): Miscellaneous info.

Updates the bot's signature. Uses the

siggy

variable to store inputs, in case they are ommited later.

motd()

Used in

update_sig()

.

moveCursor(x, y)

• x (int): The new X position of the cursor. Required.
• y (int): The new Y position of the cursor. Required.
• When forking, it's recommended you keep this function.

Moves the terminal cursor.

writeText(x, y, text, fcolor, bcolor)

• x (int): The X position of the text. Required.
• y (int): The Y position of the text. Required.
• text (str): The text to display on screen. Required.
• fcolor (int): The foreground color of the text. Defaults to the terminal's default.
• bcolor (int): The background color of the text. Defaults to the terminal's default.
• When forking, it's recommended you keep this function.

Displays text on the terminal, in a specified location, with specified colors. Crucial for managing a text-based display.

async writeTextA(x, y, text, fcolor, bcolor)

• x (int): The X position of the text. Required.
• y (int): The Y position of the text. Required.
• text (str): The text to display on screen. Required.
• fcolor (int): The foreground color of the text. Defaults to the terminal's default.
• bcolor (int): The background color of the text. Defaults to the terminal's default.

A wrapper for

writeText()

that allows you to

await

it.

bell()

Makes an audible noise.

clearLine(line)

• line (int): The line number of the line you want to clear.

Clears the specified line.

async clock()

• When forking, it's recommended you keep this function.

Runs a clock in the top-right corner of the terminal.

validCommand()

Increases the valid command count, and then writes

data

to

data.json

.

assemble_botdata()

• When forking, it's recommended you keep this function.

Used by

parse_command()

to generate data about the bot.
Returns a

dict

containing the following:

• uptime (

  datetime.datetime

  ): The time Nihonium was started.
• data (dict): The contents of

  data.json

  .
• thread_ids (list of ints): The threads parsed by this copy of Nihonium.
• post_ids (dict): The contents of

  threadData.json

  .
• cookies (

  requests.cookies.cookielib.CookieJar

  ): The cookies used to keep Nihonium logged in.
• session (

  requests.sessions.Session

  ): A session used to assist with HTTP requests.
• headers (dict): Headers sent with HTTP requests.
• version (

  versions.Version

  ): The current version of Nihonium.
• bot_info (dict): Various information about the bot.

assemble_threaddata(tID)

• tID (int): The id of the thread.
• When forking, it's recommended you keep this function.

Used by

parse_command()

to generate data about the thread the command was called in.
Returns a

dict

containing the contents of

post_ids[str(tID)]

, plus the following:

• thread_id (int): The id of the thread.

assemble_userdata(command)

• command (dict): A dict containing information about the post the command was called in.
• When forking, it's recommended you keep this function.

Used by

parse_command()

to generate data about the user who called the command.
Returns a

dict

containing the following:

• name (str): The username of the user.
• uID (int): The id of the user.

parse_command(command, tID)

• command dict: A dict containing information about the post the command was called in.
• tID (int): The ID of the thread the command was called in.
• This function is crucial to having the bot work properly, removing it is not recommended unless you know what you're doing.

Parses the given command.
Returns a string which contains the output to be displayed. This string may be empty, in which case no output is displayed for that command.

main_loop(tID, row)

• tID (int): The ID of the thread the command was called in.
• row (int): The row on the terminal display the function writes to.
• This function is crucial to having the bot work properly, removing it is not recommended unless you know what you're doing.

Scrapes commands from the thread given by

tID

, passes them to

parse_command()

to be parse, and takes the outputs and posts them to the thread.

async true_main_loop()

• This function basically is the bot, removing it is not recommended unless you really know what you're doing.

Manages several things, including the calling

main_loop()

for each of the threads, keeping track of the sixty second and thity minute waits, and some of the terminal output.

async outerloop()

Starts both

true_main_loop()

and

clock()

.

final()

Used when the bot is closed with Ctrl+C.

async exit_script()

Stops both

true_main_loop()

and

clock()

.