Skip to content

Don't completely dump the regex cache when full #72480

Description

@rhettinger
BPO 28293
Nosy @warsaw, @rhettinger, @vstinner, @ezio-melotti, @methane, @serhiy-storchaka, @zhangyangyu
PRs
  • bpo-28293: The regex cache no longer completely dump when full. #3768
  • Files
  • re_cache_pop.diff
  • re_cache_del_first.patch
  • re_cache_ordered_dict_del_first.patch
  • re_cache_ordered_dict_popitem.patch
  • Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = 'https://github.com/serhiy-storchaka'
    closed_at = <Date 2017-09-26.16:58:08.958>
    created_at = <Date 2016-09-28.04:49:29.801>
    labels = ['expert-regex', '3.7', 'library', 'performance']
    title = "Don't completely dump the regex cache when full"
    updated_at = <Date 2017-09-26.16:58:08.957>
    user = 'https://github.com/rhettinger'

    bugs.python.org fields:

    activity = <Date 2017-09-26.16:58:08.957>
    actor = 'serhiy.storchaka'
    assignee = 'serhiy.storchaka'
    closed = True
    closed_date = <Date 2017-09-26.16:58:08.958>
    closer = 'serhiy.storchaka'
    components = ['Library (Lib)', 'Regular Expressions']
    creation = <Date 2016-09-28.04:49:29.801>
    creator = 'rhettinger'
    dependencies = []
    files = ['44852', '44853', '44854', '44855']
    hgrepos = []
    issue_num = 28293
    keywords = ['patch']
    message_count = 20.0
    messages = ['277580', '277582', '277583', '277585', '277586', '277587', '277588', '277589', '277590', '277591', '277620', '277667', '277677', '277682', '278885', '278920', '278937', '283983', '303054', '303055']
    nosy_count = 9.0
    nosy_names = ['barry', 'rhettinger', 'vstinner', 'ezio.melotti', 'mrabarnett', 'methane', 'SilentGhost', 'serhiy.storchaka', 'xiang.zhang']
    pr_nums = ['3768']
    priority = 'low'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = 'performance'
    url = 'https://bugs.python.org/issue28293'
    versions = ['Python 3.7']

    Activity

    1. rhettinger commented on Sep 28, 2016

      @rhettinger
      ContributorAuthor

      When the regex cache gets filled, it is cleared in its entirety. Instead, it only needs to evict one arbitrary entry. This will save the us from having to rebuild and recache frequently used regexes.

    2. added
      stdlibStandard Library Python modules in the Lib/ directory
      performancePerformance or resource usage
      on Sep 28, 2016
    3. serhiy-storchaka commented on Sep 28, 2016

      @serhiy-storchaka
      Member

      LGTM.

    4. zhangyangyu commented on Sep 28, 2016

      @zhangyangyu
      Member

      But with the compact dict implementation, popitem is not going to evict an arbitrary entry but always the last one. Will this cause two interchangeably used regexes always need to recompile?

    5. serhiy-storchaka commented on Sep 28, 2016

      @serhiy-storchaka
      Member

      Nice catch! Here is a patch that deletes the first key.

    6. rhettinger commented on Sep 28, 2016

      @rhettinger
      ContributorAuthor

      Perhaps: _cache.pop(next(iter(_cache)))

      The for-loop version indirect about what it is trying to do and relies on an obscure quirk of exactly when it is an error to mutate while iterating.

      I do like that the side-effect of the compact dict is that is lets us choose the oldest entry to evict.

    7. serhiy-storchaka commented on Sep 28, 2016

      @serhiy-storchaka
      Member

      Perhaps: _cache.pop(next(iter(_cache)))

      This can raise KeyError if the cache is cleared in other thread. And it is a little slower.

      I remember why I didn't propose this idea earlier. This depends on the ordering of dict. But this is implementation detail, and in other Python implementation this can cause recompiling two interchangeably used regexes. No, this no longer LGTM.

      Maybe use OrderedDict? But this adds heavy dependency to the re module.

      Yet one idea: use two caches. Look first in the one cache, then in the other. When the first cache full, clear the second cache and swap caches.

    8. serhiy-storchaka commented on Sep 28, 2016

      @serhiy-storchaka
      Member

      Maybe use OrderedDict? But this adds heavy dependency to the re module.

      We can use the same trick as in the enum module. Here is a patch.

    9. zhangyangyu commented on Sep 28, 2016

      @zhangyangyu
      Member

      Why not OrderedDict.popitem(last=False)?

    10. rhettinger commented on Sep 28, 2016

      @rhettinger
      ContributorAuthor

      This has gotten crazy. I withdraw the suggestion.

    11. 3 remaining items

    12. serhiy-storchaka commented on Sep 28, 2016

      @serhiy-storchaka
      Member

      It is applied cleanly on the default branch. I don't think there is a need to open a new issue. The last patch implements the original Raymond's intention, but taking into account all comments: drops the oldest item, doesn't depend on implementation details of dict, thread-safe.

    13. rhettinger commented on Sep 29, 2016

      @rhettinger
      ContributorAuthor

      I would rather not introduce an OrderedDict dependency to the re module while other implementations are using the pure python version or where the OD implementation is in flux. This is a barely worth it proposal, so we should either make a modest, minimalistic change or just drop it. Really, its too bad that the regex got contorted in a way that precluded the use of the lru_cache (DEBUG isn't the central feature of regex and is only minimally useful).

    14. serhiy-storchaka commented on Sep 29, 2016

      @serhiy-storchaka
      Member

      The re module now depends on the enum module, and the latter already depends on OrderedDict. Thus the patch doesn't introduce new dependency. Python implementation of OrderedDict doesn't override __getitem__ and therefore don't slow down the common case. I considered all this.

      In contrary, Python implementation of lru_cache slows down the code (that is why using it was dropped in the past). But I did not object to this because re.sub() is less used than re.match() or re.search() and already is much slower.

    15. vstinner commented on Oct 18, 2016

      @vstinner
      Member

      Can't we redesign the function to reuse @functools.lru_cache(_MAXCACHE) but take care of the debug flag? For example, split the function in smaller parts.

    16. serhiy-storchaka commented on Oct 18, 2016

      @serhiy-storchaka
      Member

      This is unlikely possible with current API of lru_cache. Testing flags before looking up in a cache adds an overhead.

    17. vstinner commented on Oct 18, 2016

      @vstinner
      Member

      re_cache_ordered_dict_popitem.patch: LGTM, it can be pushed to the default branch.

      --

      "This is unlikely possible with current API of lru_cache. Testing flags before looking up in a cache adds an overhead."

      Oh wait, I looked at the code and this case is complex because the function depends on the current locale if the LOCALE flag is set... A lookup in the the cache requires to get the current locale, but not if the LOCALE flag is not set... It seems too complex for @lru_cache().

    18. methane commented on Dec 25, 2016

      @methane
      Member

      LGTM for re_cache_ordered_dict_popitem.patch

    19. serhiy-storchaka commented on Sep 26, 2017

      @serhiy-storchaka
      Member

      New changeset 114454e by Serhiy Storchaka in branch 'master':
      bpo-28293: Don't completely dump the regex cache when full. (bpo-3768)
      114454e

    20. serhiy-storchaka commented on Sep 26, 2017

      @serhiy-storchaka
      Member

      Thank you for your reviews.

      Currently the caching logic is simpler, it no longer depends on the LOCALE flag and the current locale. But it still is too complex for lru_cache. It needs a way to bypass caching based on arguments or result.

    21. transferred this issue fromon Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Metadata

    Metadata

    Labels

    3.7 (EOL)end of lifeperformancePerformance or resource usagestdlibStandard Library Python modules in the Lib/ directorytopic-regex

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions