Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

Utilities to clean up URLs

Project description

Welcome to urlclean’s documentation!

urlclean provides functions:

  • to follow a http redirect,
  • to follow a HTML META redirect,
  • to remove Urchin and Facebook tracker URL parameters,
  • plugins for futher cleaning power,
  • combines all these to unshorten and resolve various URLS

Try it out from the commandline:

python -m urlclean <some url>

Contents:

Indices and tables

  • Index
  • Module Index
  • Search Page

Documentation for the Code

urlcleaner a module that resolves redirected urls and removes tracking url params

urlclean.weedparams(url)

removes Urchin Tracker and Facebook surveillance params from urls.

Args:

url (str): The url to scrub of ugly params

Returns:

(str). The return cleaned url

urlclean.httpresolve(url, ua=None, proxyhost=’localhost’, proxyport=8118)

resolve one redirection of a http request.

Args:

url (str): The url to follow one redirect

ua (fn): A function returning a User Agent string (optional)

proxyhost (str): http proxy server (optional)

proxyport (int): http proxy server port (optional)

Returns: (str, httplib.response). The return resolved url, and
the response from the http query

urlclean.unmeta(url, res)

Finds any meta redirects a httplib.response object that has text/html as content-type.

Args:

url (str): The url to follow one redirect

res (httplib.response): a http.response object

Returns: (str). The return resolved url

urlclean.unshorten(url, cache=None, ua=None, >>**<<kwargs)

resolves all HTTP/META redirects and optionally caches them in any object supporting a __getitem__, __setitem__ interface

Args:

url (str): The url to follow one redirect

cache (PersistentCryptoDict): an optional PersistentCryptoDict instance

ua (fn): A function returning a User Agent string (optional), the default is googlebot.

>>**<<kwargs (dict): optional proxy args for urlclean.httpresolve (default: localhost:8118)

Returns: (str). The return final cleaned url.

Plugins

Plugins should have a convert function that receives and returns a URL. In case of an error an unchanged URL should be returned.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
urlclean-0.5-py2.7.egg (7.9 kB) Copy SHA256 hash SHA256 Egg 2.7 Feb 19, 2012
urlclean-0.5.tar.gz (4.3 kB) Copy SHA256 hash SHA256 Source None Feb 19, 2012

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page