code.rst

Code Documentation

Note

This section will document every part (except the API section) of our code base.

Helpers

Problematic

How can we avoid writing the same thing every time?

Documentation

PyFunceble.helpers

Download()

PyFunceble.helpers.Download

Command()

PyFunceble.helpers.Command

Regex()

PyFunceble.helpers.Regex

Dict()

PyFunceble.helpers.Dict

List()

PyFunceble.helpers.List

Directory()

PyFunceble.helpers.Directory

File()

PyFunceble.helpers.File

Hash()

PyFunceble.helpers.Hash

AdBlock

Problematic

How can we efficiently decode AdBlock filter list?

Documentation

PyFunceble.adblock

PyFunceble.adblock.AdBlock

Auto-continue

Problematic

How can we continue the test after executable stop?

Documentation

PyFunceble.auto_continue

PyFunceble.auto_continue.AutoContinue

Auto-save

Note

Only Travis CI is actually supported.

Travis CI problematic

How can we bypass the default Travis CI timeout of 45 minutes?

Documentation

PyFunceble.auto_save

PyFunceble.auto_save.AutoSave

Check

Problematic

How can we efficiently check the format of IP, domains, and URL?

Documentation

PyFunceble.check

PyFunceble.check.Check

Cleaning

Problematic

How can we clean the output/ directory so we do not have a collision between old and new files?

Documentation

PyFunceble.clean

PyFunceble.clean.Clean

Configuration

Problematics

• How can we avoid the usage of tool.py?
• How can we make personalization more simple?

Documentation

PyFunceble.config

Load()

PyFunceble.config.Load

Version()

PyFunceble.config.Version

Core

Documentation

PyFunceble.core

PyFunceble.core.Core

Database

Problematics

• How can we continuously test INACTIVE and INVALID domains or IP?
• How can we reduce the number of whois requests over time?

Documentation

PyFunceble.database

PyFunceble.database.Inactive

PyFunceble.database.Whois

Directory Structure

Problematic

How can we give make the output directory less annoying after an update?

Documentation

PyFunceble.directory_structure

PyFunceble.directory_structure.DirectoryStructure

Execution Time

Problematic

How to monitor the execution time of the session?

Documentation

PyFunceble.execution_time

PyFunceble.execution_time.ExecutionTime

Expiration Date

Problematic

How can we get the expiration date of a given domain?

Documentation

PyFunceble.expiration_date

PyFunceble.expiration_date.ExpirationDate

Generation

Problematic

How can we generate files which reflects the results of PyFunceble?

Documentation

PyFunceble.generate

PyFunceble.generate.Generate

HTTP Code

Problematic

How can we get the HTTP status code of the given domain or IP?

Documentation

PyFunceble.http_code

PyFunceble.http_code.HTTPCode

IANA

Problematic

How can we get information from IANA?

Documentation

PyFunceble.iana

PyFunceble.iana.IANA

Logs

Problematic

How can we efficiently generate and share logs?

Documentation

PyFunceble.logs

PyFunceble.logs.Logs

Lookup

Problematics

• How can we get information from WHOIS records?
• How can we check if a domain or IP have a valid pointer (nslookup)?

Documentation

PyFunceble.lookup

PyFunceble.lookup.Lookup

Mining

Problematic

How can we get the list of domain or URL which link to the desired domain, IPv4 or URL?

Documentation

PyFunceble.mining

PyFunceble.mining.Mining

Percentage

Problematic

How can we calculate the percentage of each status?

Documentation

PyFunceble.percentage

PyFunceble.percentage.Percentage

Prints

Problematic

How can we print information on the screen and on file in a table format?

Documentation

PyFunceble.prints

PyFunceble.prints.Prints

Production

Problematic

How can we efficiently prepare the repository for push/production?

Documentation

PyFunceble.production

PyFunceble.production.Production

Public Suffix

Problematic

How can we get the list of all possible or at least most used domain suffix?

Documentation

PyFunceble.publicsuffix

PyFunceble.publicsuffix.PublicSuffix

Referer

Problematic

How can we efficiently get the whois server to call for whois record request?

Documentation

PyFunceble.referer

PyFunceble.referer.Referer

Sort

Problematic

How can we format the list to test (and the outputted information) in a format other than the alphabetical format?

Documentation

PyFunceble.sort

PyFunceble.sort.Sort

Status

Problematic

How can we efficiently manage the statuses in function of the test type?

Documentation

PyFunceble.status

Normal testing

PyFunceble.status.Status

URL testing

PyFunceble.status.URLStatus

Syntax checking

PyFunceble.status.SyntaxStatus

Syntax Checking

Problematic

How can we check for syntax directly from the CLI?

Documentation

PyFunceble.syntax

PyFunceble.syntax.Syntax

URL Testing

Problematic

How can we test full URL?

Documentation

PyFunceble.url

PyFunceble.url.URL