DEV Community: Anton Shcherbatov

More abbreviations to the abbreviation's God

Anton Shcherbatov — Sun, 11 Jun 2023 19:54:17 +0000

At the work I meet a lot of different abbreviations. Some of them are insignificant, some of them are pretty useful, but most of them you're already know. Nevertheless, they describe the developing process in a way it should be and can help to build a real robust applications. There is a list of the most common of them. Which ones would you like to add?

SOLID Principles

S (Single Responsibility) Every class is responsible for the on operation only.
O (Open Closed) The classes have to be open for extending and closed for modification
L (Liskov substitution) It should be possible to use a child class (type) instead of a parent without negative consequences
I (Interface Segregation) You shouldn't force a class to implement an interface, which doesn't relate to the class
D (Dependency Inversion) Abstractions don't depend on the details, but details do depend on the abstractions

YAGNI (You're not gonna need it) If you're writing the code, ensure you're gonna use it. Don't add the code if you think it'll be useful later
DRY (Don't repeat yourself) Pretty obvious. Don't hurry to write the code - look around. Likely, someone already wrote it. This is why I love pull requests for - somebody can remember that your functional already exists and we don't actually need. Seriously?! Where have you been during the sprint planning?!
KISS (Keep it simple, stupid) Well, just be simpler. The simpler code, the better it works. If a task doesn't require over-complicated solution, just use the solution. It supposes that you have multiple solution of the task. Haha :\
BDUF (Big design up front) This is what I'm lack in. No time to think, just write the ~~f..~~ code. It's incorrect. Before starting coding, ensure that everything is well thought out
APO (Avoid Premature Optimization) Don't force the code optimization until it's really necessary.

There are much more abbreviations in a programming world. Which one is your favourite? My favourite is LGTM in the comments of pull requests!

Bottle+Sqlite

Anton Shcherbatov — Thu, 01 Jun 2023 19:10:50 +0000

A few more words about Bottle. After enabling a sqlite extension, you can easily include a specified keyword as a view argument. Like:

app = bottle.Bottle()
db_plugin = bottle_sqlite.Plugin(dbfile='./test.db', keyword="db")
app.install(db_plugin)

@app.route("/")
def main(db):
    ....

It works perfect... Until you decide to show the view for authorized users only. And this

@bottle.auth_basic()
def save_post(db):
    ...

will cause

TypeError("main() missing 1 required positional argument: 'db'")

This is a known issue, which still wasn't solved on the plugin level. So, again workarounds

The only change here is:

params = inspect.signature(_callback).parameters
if keyword not in params:
    return callback

instead of

argspec = inspect.getargspec(_callback)

Bottle

Anton Shcherbatov — Tue, 30 May 2023 09:02:48 +0000

Bottle is a really small python-based framework. The whole its code takes 1 file with ~4000 rows. Meanwhile, Bottle is pretty self-sufficient - it supports:

wsgi-server
routing
authorization
plugins
own templates language
a lot of extensions (mostly one-paged too)
custom error pages
and much more!

I was excited trying to write my blog using Bottle. The first issue I faced - you can login, but you can't logout :D

Bottle supports basic auth mechanism, so you can do something like:

def auth_callback(user, password):
    return user == password  # or any check you want

@bottle.auth_basic(auth_callback)
def edit_post(db, post_id):
    ....

But there is no way to logout. The only workaround I found is to return 401 status as a response. It allows to force logout the user. It's not quite correct, because user doesn't expect to get 401Error on logout, but this is why it's called workaround.

To make the solution to look more pretty I also customized 401 Error page, by adding an html-template with link to login.

def logout():
    return bottle.abort(401)

@app.error(401)
def error_401(error):
    return bottle.template("errors/401")

app.route("/logout/", ["GET"], logout)

As alternative, there is an extension for bottle, called bottle-login, which has been archived few years ago.

klen / bottle-login

Implement users' sessions in Bottle framework

Bottle Login

Bottle Login -- Implement users' sessions in Bottle web framework.

Contents

Requirements

python >= 2.6

Installation

Bottle Login should be installed using pip:

pip install bottle-login

Usage

from bottle import Bottle, request, redirect
from bottle_login import LoginPlugin

app = Bottle()
app.config['SECRET_KEY'] = 'secret'

login = app.install(LoginPlugin())

@login.load_user
def load_user_by_id(user_id):
    # Load user by id here


# Some application views

@app.route('/')
def index():
    current_user = login.get_user()
    return current_user.name

@app.route('/signout')
def signout():
    # Implement logout
    login.logout_user()
    return redirect('/')

@app.route('/signin')
def signin():
    # Implement login (you can check passwords here or etc)
    user_id = int(request.GET.get('user_id'))
    login.login_user(user_id)
    return redirect('/')

Bug tracker

If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/bottle-login/issues

Contributing

Development of Bottle Login happens at: https://github.com/klen/bottle-login

Contributors

klen (Kirill Klenov)

License

Licensed under a BSD license.

View on GitHub

First post

Anton Shcherbatov — Mon, 29 May 2023 21:01:16 +0000

Well, this is probably the first time when I use this title not for testing purposes. Although, this is still gonna be a part of experiment, where I'm trying different kind of frameworks, technologies, skills and share all the useful (for me) and interesting (again, for me) information.