Code Monkey home page Code Monkey logo

escapism's Introduction

Escapism

Simple escaping of text, given a set of safe characters and an escape character.

Usage

Not much to it. Two functions:

escaped = escapism.escape('string to escape')
# 'string_20to_20escape'
original = escapism.unescape(escaped)

There are two optional arguments you can pass to escape():

  • safe: a string or set of characters that don't need escaping. Default: ascii letters and numbers.
  • escape_char: a single character used for escaping. Default: _. escape_char will never be considered a safe value.

unescape() accepts the same escape_char argument as escape() if a value other than the default is used.

import string
import escapism
safe = string.ascii_letters + string.digits + '@_-.+'
escape_char = r'%'
escaped = escapism.escape('foø-bar@%!xX?', safe=safe, escape_char=escape_char)
# 'fo%C3%B8-bar@%25%21xX%3F'
original = escapism.unescape(escaped, escape_char=escape_char)

escapism's People

Contributors

minrk avatar

Stargazers

avatar avatar avatar

Watchers

avatar avatar avatar avatar

Forkers

andrew-dupuis arpitjain799 wolfi-chainguard-demo

escapism's Issues

License

As I was scanning over the setup.py I noticed the following

    license             = "BSD",

        'License :: OSI Approved :: MIT License',

Escaping an underscore adds "5F" to the word

Hi!
I use escapism as it is part of the dockerspawner:

https://github.com/jupyterhub/dockerspawner/blob/master/dockerspawner/dockerspawner.py#L20

I have a string containing an underscore, and after escaping it by an underscore, I have an additional two characters: 5F (which is a part of an URL-encoded underscore). It appears to me that everytime the replacement character (third argument) is actually contained in the original string, it adds characters.

This is very unexpected. And it is very unpractical, as I cannot of course control the characters in my original string (if I could, I would not escape them).

Whether that replacement character is part of the "safe" characters does not affect this behaviour.

I am using Python 3.6 on a linux machine.

Please see here:

yyy@yyy:/srv/jupyterhub# python3 
Python 3.6.9 (default, Nov  7 2019, 10:44:02) 
[GCC 8.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import escapism
>>> import string
>>> s = 'foo_foo'
>>> safe = set(string.ascii_letters + string.digits + "-")
>>> e = escapism.escape(s, safe, '_')
>>> e
'foo_5Ffoo'

It does not change if I add the underscore to the safe chars:

>>> import escapism
>>> import string
>>> 
>>> s = 'foo_foo'
>>> safe = set(string.ascii_letters + string.digits + "-"+ "_")
>>> 
>>> 'f' in safe, 'o' in safe, '_' in safe
(True, True, True)
>>> 
>>> escapism.escape(s, safe, '_')
'foo_5Ffoo'

And actually, it removes the replacement character from the safe characters:

>>> import escapism
>>> 
>>> s = 'foo_foo'
>>> safe = {'f','o','_','x'}
>>> safe
{'o', '_', 'f', 'x'}
>>> escapism.escape(s, safe, 'x')
'foo_foo'
>>> safe
{'o', '_', 'f'}
>>> # x was removed
>>> escapism.escape(s, safe, 'x')
'foo_foo'
>>> safe
{'o', '_', 'f'}

And it adds characters to every occurrence of the replacement character in the string, no matter whether it is safe or not:

>>> import escapism
>>> s = 'foo_foo'
>>> safe = {'f','o','_'}
>>> safe
{'o', '_', 'f'}
>>> escapism.escape(s, safe, 'o')
'fo6Fo6F_fo6Fo6F' ### <-- chars were added!
>>> safe
{'_', 'f'}      ### <-- o was removed from safe!

Can anybody reproduce this?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.