URLExtract

Warnings

• gotcha URLExtract's TLD-based detection can lead to 'false matches' in certain contexts, such as CSS class names (e.g., `p.bold.name` might be extracted if `.name` is a valid TLD). The library correctly identifies these as valid patterns, but they might not be the intended URLs.
  Fix: Review extracted URLs in contexts where non-URL patterns might coincidentally contain TLDs. Consider using the `with_schema_only=True` parameter in `find_urls` if you only need URLs with explicit schemes (e.g., 'http://', 'https://').
• gotcha Users have reported `urlextract.cachefile.CacheFileError` or issues with custom cache directories not saving TLDs, especially in bundled applications (like PyInstaller) or read-only file systems.
  Fix: Ensure the application has write permissions to the default cache directory or a custom directory specified during `URLExtract` initialization. Manually update the TLD list using `extractor.update()` if necessary. Consider reporting the issue on the GitHub repository for specific edge cases.
• breaking Support for Python 3.6 has been dropped in recent versions due to underlying dependency changes (e.g., `filelock`). Users on Python 3.6 will encounter errors.
  Fix: Upgrade to Python 3.7 or newer. Python 3.12 support was added in v1.9.0.
• gotcha Older versions (prior to 1.9.0) might incorrectly parse URLs within Markdown links or have issues with filtering mixed-case hostnames, leading to incomplete or incorrect extractions.
  Fix: Upgrade to version 1.9.0 or later to benefit from fixes for Markdown link parsing and mixed-case hostname filtering.

Install

• pip install urlextract Install URLExtract

Imports

• URLExtract

  from urlextract import URLExtract

Quickstart

Initializes the URLExtract class and uses the `find_urls` method to extract all URLs from a given text string.

from urlextract import URLExtract

extractor = URLExtract()
text = "Check out our website: example.com or find us at https://www.another-example.org/path?query=1"
urls = extractor.find_urls(text)

print(urls)
# Expected output: ['example.com', 'https://www.another-example.org/path?query=1']