sphinx-contrib / sphinx-contrib/openapi

recursion limit exceeded (and seg faults with increased python recursion limit)

Open
#86 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Python
Stars
126
Forks
88
PR merge metrics
No merged PRs in 30d

Description

I believe there is an infinite loop in the recursion in the utils _do_resolve function. I have tried to replicate the issue from building out some of my own config files but haven't been able to do so. I have supplied our config file since its what is currently causing the issue in hopes that you have a better grasp than myself on what the issue might be.

Most of the Objects in this are either a LocalPlugin or RemotePlugin.
Some history behind our configuration file here. Our project is an open source Spring boot project (https://github.com/racker/salus-telemetry-monitor-management) and we are generating the swagger from https://github.com/kongchen/swagger-maven-plugin.
Github doesn't allow the uploading of yml files so I just changed the extension.
swagger.txt

Please let me know if you need more information or clarification from me.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the utils _do_resolve function and use the attached swagger.txt configuration to investigate the recursion-limit failure. Confirm whether the input causes an infinite resolution loop, then verify that the configuration resolves without exhausting Python's recursion limit or segfaulting.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.