<commit_before><commit_msg>docs about U object<commit_after>U object
========


``U`` object is ``URLPattern`` instance. It is used as replacement over regular
expression. It is similar to  .. _Pathlib.Path: https://docs.python.org/3/library/pathlib.html

You should combine U object with RE patterns, you can do it like this:

::

    from urljects import U, slug, url, view_include

    choice = r'(?P<choice>YES|NO)')

    urlpatterns = [
        url(U / 'detail' / slug, views.DetailView),   # -> r'^detail/(?P<slug>[\w-]+)$'
        url(U / choice, views.ChoiceView)             # -> r'^(?P<choice>YES|NO)')'

        url(U / 'eshop', view_include(eshop_views))   # -> r'^eshop/' + included urls
    ]

{'fraction_non_alphanumeric': 0.16831683168316833, 'fraction_numerical': 0.0014144271570014145, 'mean_word_length': 3.092485549132948, 'pattern_counts': {'":': 0, '<': 6, '<?xml version=': 0, '>': 9, 'https://': 1, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6913461', 'n_tokens_mistral': 246, 'n_tokens_neox': 234, 'n_words': 63}