Python implementation for generating Tiny URL- and bit.ly-like URLs.

Alireza Savand

Last update: Dec 28, 2022

Related tags

URL Manipulation python-short_url

Overview

Short URL Generator

Python implementation for generating Tiny URL- and bit.ly-like URLs.

A bit-shuffling approach is used to avoid generating consecutive, predictable URLs. However, the algorithm is deterministic and will guarantee that no collisions will occur.

The URL alphabet is fully customizable and may contain any number of characters. By default, digits and lower-case letters are used, with some removed to avoid confusion between characters like o, O and 0. The default alphabet is shuffled and has a prime number of characters to further improve the results of the algorithm.

The block size specifies how many bits will be shuffled. The lower BLOCK_SIZE bits are reversed. Any bits higher than BLOCK_SIZE will remain as is. BLOCK_SIZE of 0 will leave all bits unaffected and the algorithm will simply be converting your integer to a different base.

The intended use is that incrementing, consecutive integers will be used as keys to generate the short URLs. For example, when creating a new URL, the unique integer ID assigned by a database could be used to generate the URL by using this module. Or a simple counter may be used. As long as the same integer is not used twice, the same short URL will not be generated twice.

The module supports both encoding and decoding of URLs. The min_length parameter allows you to pad the URL if you want it to be a specific length.

Sample Usage:

>>> import short_url
>>> url = short_url.encode_url(12)
>>> print url
LhKA
>>> key = short_url.decode_url(url)
>>> print key
12

Use the functions in the top-level of the module to use the default encoder. Otherwise, you may create your own UrlEncoder object and use its encode_url and decode_url methods.

Install

short_url is also available at pypi:

http://pypi.python.org/pypi/short_url

Give a try to your finger:

$ pip install short_url

And done ;)

Tests

short_url is tested on both python2 and python3, to run the tests:

$ tox

Source	https://github.com/Alir3z4/short_url
Website	http://alir3z4.github.com/short_url
Issues	https://github.com/Alir3z4/short_url/issues
PyPi	http://pypi.python.org/pypi/short_url
Author	Michael Fogleman
Maintainer	Alireza Savand
License	MIT
Link	http://code.activestate.com/recipes/576918/

Comments

Make Python 3 compatible

Hi, could you try to make short_url compatible with Python 3,

The statment """ n & ~self.mask """ returns an """ TypeError: unsupported operand type(s) for &: 'str' and 'int' """ on Python 3

opened by loechel 3

Not generating alpha strings?

I'm getting int responses from short_url.encode() Possibly an environment issue?

Reproduction

$ pip install short_url
   Collecting short_url
   Installing collected packages: short-url
   Successfully installed short-url-1.2.2

Python 2.7.11 (default, Feb 19 2017, 23:20:53)
IPython 4.1.1 -- An enhanced Interactive Python.
In [1]: import short_url
In [2]: print short_url.encode(12)
3145728

Expected LhKA instead of 3145728

opened by perrierism 2

As there a way to predict the maximum length?

I would like to save URLs in a database field. What is the maximum number of characters I will need for a given range of integer numbers or: Is there a safe length which will always suffice for 32-bit integers as input?

Thanks for publishing this project!

opened by mcrot 1

Make it work with a real URL

Re-Issue an old issue from http://code.activestate.com/recipes/576918/

is there a way to make it work with a url? i can shorten integers all day long, but when i actually enter a url i get this:

>> import short_url
>> link = '/home/gmilby/public_html/syrbotwebdesign.com/scripts/playground'
>> url = short_url.encode_url(link)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "short_url.py", line 66, in encode_url
    return DEFAULT_ENCODER.encode_url(n, min_length)
  File "short_url.py", line 15, in encode_url
    return self.enbase(self.encode(n), min_length)
  File "short_url.py", line 19, in encode
    return (n & ~self.mask) | self._encode(n & self.mask)
TypeError: unsupported operand type(s) for &: 'str' and 'long'

i kept shaving off the beginning (http:, then // then...) same error everytime.

is there a way to short a real URL? (Protocoll://hostname:port/path) not only Integer values, if not the package name is misleading.

opened by loechel 1

Torrent magnet links
Hi, thank you for the amazing work! I tried many APIs to short a magnet link, for example

import pyshorteners s = pyshorteners.Shortener() s.tinyurl.short('magnet:?xt=urn:btih:44EA47CF8DF204C8E5DF79A255809D47AC94C21B')

and I got https://tinyurl.com/y8ykwlpb which however redirect to http://magnet/?xt=urn:btih:44EA47CF8DF204C8E5DF79A255809D47AC94C21B which doesn't work since it does not open the bittorrent client. Is there a way to short a magnet link? Thank you
opened by Rabelaiss 0
Missing tests in PyPI release

The PyPI release tarball should contain the test cases. These are usually ran by distributions that package Python modules in order to ensure their basic usability.

opened by mia-0 1

Releases(1.2.2)

1.2.2(May 31, 2016)
1.2.2 2016-05-31

Fix #15: bug in division of huge numbers

Add more Python Version to test.

Source code(tar.gz)
Source code(zip)