furl: The Easiest Way to Parse and Modify URLs in Python

Introduction

furl is a small yet powerful Python library that provides an exceptionally easy way to parse and modify URLs. While Python's standard urllib and urlparse modules offer URL-related functions, furl streamlines common operations, making URL manipulation intuitive and less prone to errors. It handles complex aspects like encoding and internationalized domain names seamlessly, allowing developers to focus on their application logic.

Installation

Installing furl is straightforward using pip:

pip install furl

Examples

furl simplifies common URL operations. Here are a few examples demonstrating its ease of use:

Modifying Paths and Query Arguments:

from furl import furl

f = furl('http://www.google.com/?one=1&two=2')
f /= 'path'
del f.args['one']
f.args['three'] = '3'
print(f.url)
# Output: 'http://www.google.com/path?two=2&three=3'

Inline Modification Methods:

from furl import furl

# Add arguments
print(furl('http://www.google.com/?one=1').add({'two':'2'}).url)
# Output: 'http://www.google.com/?one=1&two=2'

# Set arguments (replaces existing)
print(furl('http://www.google.com/?one=1&two=2').set({'three':'3'}).url)
# Output: 'http://www.google.com/?three=3'

# Remove arguments
print(furl('http://www.google.com/?one=1&two=2').remove(['one']).url)
# Output: 'http://www.google.com/?two=2'

Handling Encoding and Unicode:

furl automatically handles URL encoding and supports Unicode characters.

from furl import furl

f = furl('http://www.google.com/')
f.path = 'some encoding here'
f.args['and some encoding'] = 'here, too'
print(f.url)
# Output: 'http://www.google.com/some%20encoding%20here?and+some+encoding=here,+too'

f.set(host='????.???', path='???', query='?=?')
print(f.url)
# Output: 'http://xn--eckwd4c7c.xn--zckzah/%D0%B4%D0%B6%D0%BA?%E2%98%83=%E2%98%BA'

Why Use furl?

furl stands out by offering a highly intuitive and Pythonic interface for URL manipulation. It addresses the common frustrations associated with urllib.parse by providing direct access to URL components like scheme, host, path, query, and fragment. Key benefits include:

• Simplicity: Easily parse and modify any part of a URL with simple attribute assignments and dictionary-like access for query parameters.
• Robust Encoding: Automatically handles percent-encoding and decoding, including support for Unicode and Internationalized Domain Names (IDNs).
• Method Chaining: Supports inline modification methods (add, set, remove) for concise and readable code.
• Detailed Control: Offers granular control over path segments, query parameters (including multivalue support), and fragment components.
• Well-Tested: The library is thoroughly tested, ensuring reliability in various scenarios.

Links

• GitHub Repository: https://github.com/gruns/furl
• PyPI: https://pypi.python.org/pypi/furl