Functions¶

openpyweb Provides bundles of in-bulit functions that support mvc app development, Each of the functions are useful and will break all limit and doubt as you get to know how to use them. These modules are created to make app building more easier and faster. Expect more functions in new released versions.

Note

Some functions will be re-consider as standalone module and be made as dependencies in the future. Making openpyweb framework more flexible and elegant.

Langauge(__)¶

openpyweb provides inbuilt langauge module __, this module is responsible for translation / internationalization of word around openpyweb application. Our project target is to support English, Russain and french world, the we will need to create content with multiple langauges . example when our users access http://mydomainname.com/en it will display english content, http://mydomainname.com/ru it will display russain content, and http://mydomainname.com/fr it will display french content, using the help of lang method and lang argument.

Note

Language files are stored/saved in lang folder as .py in openpyweb folder project and it uses dictionary.

Example: Below will be save in en.py file

{
    'lng.test': 'Welcome',
    'text' : 'programming'
}

Example: Below will be save in ru.py file

{
    'lng.test': 'zhelannyy',
    'text' : 'programmirovaniye'
}

Example: Below will be save in fr.py file

{
    'lng.test': 'Bienvenue',
    'text' : 'programmation'
}

Import Module

from openpyweb.Functions.__ import __

Callable

lang = __()

Template Engine

{% call __ "lng.test" %}

{% call __ lang='lng.test'  %}

{% call __ 'lang' lang='lng.test'  %}

Count¶

Count Module coverts integer of float count to human readable format with the help of digit and bytes method.

Import Module

from openpyweb.Functions.count import count

Callable

count = count()

digit returns count of T as trillion, M as Million, K as Thousand.

count.digit(432) #this will return 432

count.digit(4324) #this will return 4.3k

count.digit(43242) #this will return 43.2k

count.digit(432427) #this will return 432.4k

count.digit(4324276) #this will return 4.3M

bytes returns bytes size of B as Bytes, KB as Kilobyte, MB as Megabyte, GB as Gigabyte and TB as Terabyte

count.bytes(444) #this will return B

count.bytes(1024) #this will return 1K

count.bytes(1048576) #this will return 1.00MB

count.bytes(4324273243) #this will return 4.03GB

count.bytes(432434327323243) #this will return 393.30 TB

Agent¶

Agent Module, get users or visitors web browser and operating system information such as name and version

Note

Agent module is a dependency, and it might no longer be maintain under the openpyweb repository, if you find this module useful and you want to keep using its features in your project. We recommend installation of pip install openpyweb_agent.

Import Module

from openpyweb.Functions.agent import os, browser

OS Callable

os = os()

get operating system name

os.name

get device

os.device

Browser Callable

browser = browser()

get browser name

browser.name

how get browser version

browser.version

Ip Address¶

Ip Module checks visitors/audiences, proxy, sock, VPN, and IPs address.

it returns a response such as :- hostname, country, city, region, loc, org

Import Module

from openpyweb.Functions.ip import ip

Callable

ip = ip()

how to get HTTP IP ADDRESS

ip.get().ip

how to get VPN IP ADDRESS

ip.vpn().ip

how to check if visitor is using VPN

To know if visitor is using a vpn, we’ll need to use vpn method with is_vpn attribute which will return bool True or False

ip.vpn().is_vpn

how to get IP ADDRESS and PROPERTIES

we’ll be getting our app visitors ip, hostname, city, country loc and org

visitors = ip.get()
visitors.ip
visitors.hostname
visitors.city
visitors.region
visitors.country
visitors.loc
visitors.org

default check IP ADDRESS

Cases whereby there is an ip and we want to get the ip information we will use property method

ip.property('41.190.30.100').hostname
ip.property('41.190.30.100').city
ip.property('41.190.30.100').region
ip.property('41.190.30.100').country
ip.property('41.190.30.100').loc
ip.property('41.190.30.100').org

Path¶

openpyweb path module handles method path, exist , public argument which return root path as string.

Import Module

from openpyweb.Functions.path import path

Callable

path = path()

Example

path.path(path = "users")

Example

path.public(path)

Example

path.exist(newpath, defaultpath)

Url¶

openpyweb url module handles uniform resource locator notation using url method with path argument which returns the application link

Import Module

from openpyweb.Functions.url import url

Callable

url = url()

Example

url.url(path = "users")

Template Engine

{% call url path = "users" %}

{% call url "users"}

Readmore¶

openpyweb readmore module helps to hide or limit long content using lstring method with the following argument``text`` accept content, empty by default. trim accept bool (True or False) length accept integer which is the set limit by default set to 100000000000. link accept string which is the url direction, empty by default. label accept string, set to Read more by default. css accept css(cascading style sheet) as a string and set to readmore by default. All default attributes are changable.

Import Module

from openpyweb.Functions.readmore import readmore

Callable

readmore = readmore()

Example

readmore.lstring(text="", trim = 'False', length = '1', link="", label="Read more",  css="readmore"):

Template Engine

{% call readmore text='' trim=True lenght=180 link="url/read/"  %}

Iteration¶

openpyweb iteration module handles iteration, enumerate dictionary and Json.

Import Module

from openpyweb.Functions.iteration import iteration

Callable

iter = iteration()

Example Country

country = [{ 'country_name': 'Afghanistan'}, {'country_name': 'Aland Islands'}, { 'country_name': 'Albania'}']

Example Table Result

List Country

Afghanistan

Aland Islands

Albania

Nigeria

Example Country with iteration

country = [{ 'country_name': 'Afghanistan'}, {'country_name': 'Aland Islands'}, { 'country_name': 'Albania'}']

iter.iteri(country, 'id')

Example Iteration Table Result

id

List Country

1

Afghanistan

2

Aland Islands

3

Albania

4

Nigeria

Curl¶

openpyweb curl is an in-built module support sending or initiating actions within or outside openpyweb framework. It enables access to API’s and return respond back to the application, in form of JSON, HTML, RAW data etc. In this case the use of curl module is to POST, GET, HEAD, PUT information in internal or from external API’s URL using attributes like status, reason, and result. Whereby status handles response codes example 200, 404, 500, etc. which the reason of this status could be OK, Not Found, Internal server Error, etc. Get excepted information from result

Import Module

from openpyweb.Functions.curl import curl

Callable

cl = curl()

Curl Local Variable

URL #accept url link
HTTPHEADER #httpheader  application/x-www-form-urlencoded etc.
CONTENTHEADER #accept text/plain, html/plain etc.
TIMEOUT #accept
POSTFIELDS #accept dictionary formate {name: example, next: testing}
POST #accept folder or url part / or /mypath
GET #accept folder or url part / or /mypath
HEAD #accept folder or url part / or /mypath
PUT #accept folder or url part / or /mypath
PORT #accept url port 8080

GET retrieves information from api’s server and returns response status , reason, and result

url = "https://example.com"
cl = curl()
cl.set(cl.URL, url)
cl.set(cl.GET, '/users/{username}'.format(username='testme'))
cl.finish()
print(cl.status, cl.reason, cl.result())

HEAD check api’s and returns response status and reason

url = "https://example.com"
cl = curl()
cl.set(cl.URL, url)
cl.set(cl.HEAD, '/users')
cl.finish()
print(cl.status, cl.reason)

POST sent data/information to api using parameters or arguments and returns response status , reason, and result

url = "https://example.com"
cl = curl()

cl.set(cl.URL, url)
cl.set(cl.CONTENTHEADER, 'application/x-www-form-urlencoded')
cl.set(cl.ACCEPTHEADER, 'text/plain')
cl.set(cl.POST, '/add/users')
cl.set(cl.POSTFIELDS, {'username':'testme', 'password':'test' })
cl.finish()
print(cl.status, cl.reason, cl.result('utf-8'))

HEADER sent data/information to api using parameters or arguments: and returns response status , reason, and result

url = "https://example.com"
header = {}
cl = curl()
cl.set(cl.URL, url)
cl.set(cl.CONTENTHEADER, 'application/x-www-form-urlencoded')
cl.set(cl.HEADER, header)
cl.finish()
print(cl.status, cl.reason, cl.result('utf-8'))

Now¶

Now module handle time, date functions and accuracy, you might know what time and date are because it happens every date, openpyweb provides the best way to handle time date and format with additional future like readable time and date. now module contains methods that support ago, time, date, datetime, create, timestamp, past, future, subtract Now module is usable on both openpyweb template engine, controller and model

Import module

from openpyweb.Functions.now import now

callable

nowdatetime = now()

Ago: covert datetime to readable format 1 year 20 minutes ago accept string and format as argument %Y-%m-%d %H:%M:%S

Example 1 : returns 32 minutes ago.

nowdatetime.ago("2020-01-09 08:32:18")

Date: return correct date, let say todays date 2020-01-09 accept format as argument, default format is set to %Y-%m-%d

Example 1 : returns 12:30:59

nowdatetime.date()

Time: return correct time, let say my present 12:30:59 accept format as argument, default format is set to %H:%M:%S

Example 1: returns 12:30:59

nowdatetime.time()

Date: return correct date, let say todays date 2020-01-09 08:18:03 accept format as argument, default format is set to %Y-%m-%d %H:%M:%S

Example : returns 2020-01-09 08:18:03

nowdatetime.datetime()

Create: This method helps to create new datetime from an existing datetime. In other words changing a previous datetime format to a new datetime format. Let say our present 2020-01-09 08:18:03 and format %Y-%m-%d %H:%M:%S we want to change it to 01-09-2020 08:18 and the formation for this will be %Y-%m-%d %H:%M.

Example : returns 01-09-2020 08:18

nowdatetime.create("2020-01-09 08:18:03", oldformat="%Y-%m-%d %H:%M:%S", newformat="%Y-%m-%d %H:%M ")

Timestamp: return correct unix time and with the same method covert timestamp to date and time. Let say it returns 1578576738 and we want to convert it to datetime. We will need to use the same timestamp method and it returns 2020-01-09 08:32:18

Example 1: returns 1578576738

nowdatetime.timestamp()

Example 2: returns 2020-01-09 08:32:18

nowdatetime.timestamp('1578576738')

Past: returns previous minutes, hours, days, weeks, seconds, let say we want to go back to 27 days from today date and time.. now in our calendar todays date and time is 2020-01-09 08:32:18

Example : returns 2019-12-13 08:58:15.983552

nowdatetime.past(days=20)

Future: returns Next Date (future) minutes, hours, days, weeks, seconds, let say we want to look into 27 days from today date and time.. now in our calendar todays date and time is 2020-01-09 08:32:18

Example: returns 2020-02-05 09:02:08.269823

nowdatetime.future(days=20)

Subtract: subtracting or minus a date time from another from date time.. this process comment both date time to provide their format respectively. Argument are date1, format1 and date2 format2

Example : returns 27

nowdatetime.subtract(date1='2020-01-09 08:32:18', format1='%Y-%m-%d %H:%M:%S',  date2='2019-12-13 08:58:15.983552', format2='%Y-%m-%d %H:%M:%S.%f')

Extend / Include¶

openpyweb has a wonderful module that handles both including and extending of external file or paging include

and extend module helps to structure and manage file architecture. Cases where you have a file named header and all your content or code are saved in it and you want to use it in other file or page of your web application, include module handles that purpose but you can extend or include. At this stage you might be wondering what’s difference between the both properties, actually no difference.

This modules are mostly used when working with openpyweb Template Engine or html pages

Sample: we are including and extending a file named header.html where home is the parent folder in our views folder and inc is a sub folder, using dot . sign to separate both folders and file. The last dot signifies last or end of the folder and next is the file. Exception is thrown if your file path or folder cannot be located, this might result in page not found or error path.

Example: Include

{% call include 'home.inc.header'  %}

Example: Extend

{% call extend 'home.inc.header'  %}

Let make callable outside template engine

from openpyweb.Functions.extend import extend
extending = extend()

extending.extend(path="home.inc.header")

Validations¶

openpyweb validation module provides bundles of validity functions that help to validate and trim syntax, string and characters. This Callable module are used when developing application that involves checking of inputted datas or support accuracy in data supply.

Import Module

from openpyweb.Functions.validation import validation

Callable

valid = validation()

Method ip validates only digits and character that contains . returns bool True or False render support IP Address http://domainname.com, https://domainname.com , ftp://domainname.com , www.domainname.com

Example

url_validations = valid.url('ftp://domainname.com')

Method ip validates only digits and character that contains . returns bool True or False render support IP Address 0.0.0.0 123.123.12.1

Example

ipaddress_validation = valid.ip('123.123.12.1')

Method phone validates only digits and character contains - and +, returns bool True or False render support to phone number: +1-000-000-000, 10000000000 , 0000000000, 0000-000-0000, 00000000000 , +1000000000

Example

phone_validations = valid.phone("+234-800-000-6000")

Method count return total count of a string

Example

count = valid.count('i love python')

Method email validates only alphabet and character . , _ , - and @, returns bool True or False render support to email address my_email@gmail.com, email@gmail.com , my.email@gmail.com, my_email@gmail.com

Example

email_validations = valid.email('my_email@gmail.com')

Method fullname validates full name input field returns True or False : firstname lastname prefix firstname lastname

Example

fullname_validations = valid.fullname("prefix firstname lastname")

Method extension check and validate list of prefix if exist in or as an occurrence in the list, returns True or False

Example

get_extension = valid.extension('filename.jpg', ['png', 'jpg'])

Method length check and valid the starting length of a string and expected end, where minimum min is integer and maximum max integer (‘I love', min, max) returns True or False

Example

length_validation = valid.length('i love python', 4, 18)

Pagination¶

openpyweb provides pagination module that helps to navigate through pages and tables, it has favorites of methods that meetup expectations number, alphabet , alphabet_first_last , next_previous, first_last Each of the method has same argument and parameter total, page, url, css.

Import Module

from openpyweb.Functions.pagination import  pagination

Callable

pagin = pagination()

Example: Numbering Pagination

pagin.number(total=10, page = 1, url='/blog', css=['pagination’, 'page-item', 'page-link'])

Example: Alphabet Pagination

pagin.alphabet(total=10, page = 'A', url='/blog', css=['pagination', 'page-item', 'page-link'])

Example: Alphabet First Last Pagination

pagin.alphabet_first_last(total=10, page = 'A', url='/blog', css=['pagination’, 'page-item', 'page-link'])

Example: Next Previous Pagination

pagin.next_previous(total=10, page = 1, url='/blog', css=['pagination’, 'page-item', 'page-link'])

Example: First Last Pagination

pagin.first_last(total=10, page = 1, url='/blog', css=['pagination’, 'page-item', 'page-link'])