René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Idea: Use case for a VersionIterator?","articleBody":"## Situation\r\n\r\nFor example, if we want to start from a certain version and get the next 3 versions we could do that:\r\n\r\n```python\r\nv = VersionInfo.parse(\"1.2.3-rc.3\")\r\nfor _ in range(3):\r\n   print(v.next_version(part=\"prerelease\"))\r\n```\r\n\r\nThis would work, but maybe we could use the iterator protocol for that.\r\n\r\n## Proposed Solution\r\n\r\nThe solution is very rough, but that's on purpose. It's a minimal example to demonstrate the idea and not get distracted by other methods. So I know, this would need fine-tuning (add properties, protect from invalid datatypes etc.).\r\n\r\n```python\r\nclass VersionInfoIterator:\r\n    \"\"\"Iterator over VersionInfo objects\"\"\"\r\n    def __init__(self, version, part, steps=10):\r\n        self.version = version\r\n        self.part = part\r\n        self._steps = steps\r\n\r\n    def __iter__(self):\r\n        return self\r\n\r\n    def __repr__(self):\r\n        cls = type(self)\r\n        return \"{}(version={!r}, part={!r}, steps={})\".format(cls.__name__,\r\n                self.version, self.part, self._steps)\r\n\r\n    def __next__(self):\r\n        if not self.steps:\r\n            raise StopIteration\r\n        self._steps -= 1\r\n        self.version = self.version.next_version(self.part)\r\n        return self.version\r\n```\r\n\r\nAn implementation could look like this:\r\n\r\n```python\r\nfrom semver import VersionInfo, VersionInfoIterator\r\n\u003e\u003e\u003e v = VersionInfo.parse(\"1.2.3-rc.3\")\r\n\u003e\u003e\u003e vit = VersionInfoIterator(v, \"prerelease\", steps=3)\r\n\u003e\u003e\u003e next(vit)                                               \r\nVersionInfo(major=1, minor=2, patch=3, prerelease='rc.4', build=None)\r\n\u003e\u003e\u003e next(vit)                                                                                                                              \r\nVersionInfo(major=1, minor=2, patch=3, prerelease='rc.5', build=None)\r\n\u003e\u003e\u003e vit.part = \"minor\"\r\n\u003e\u003e\u003e next(vit)    \r\nVersionInfo(major=1, minor=3, patch=0, prerelease=None, build=None)\r\n\u003e\u003e\u003e next(vit)\r\nTraceback (most recent call last)\r\n...\r\nStopIteration\r\n\r\n# or\r\n\r\n\u003e\u003e\u003e vit = VersionInfoIterator(v, \"prerelease\", steps=3)\r\n\u003e\u003e\u003e list(vit)\r\n[VersionInfo(major=1, minor=2, patch=3, prerelease='rc.4', build=None),\r\n VersionInfo(major=1, minor=2, patch=3, prerelease='rc.5', build=None),\r\n VersionInfo(major=1, minor=2, patch=3, prerelease='rc.6', build=None)]\r\n```\r\n\r\n## Questions\r\n\r\n* Would such an iterator be useful?\r\n* Is it necessary or is first example above enough when iterating?\r\n* If you think it could be useful, would you change something in `__init__`?\r\n\r\nActually, I'm not sure myself if this is something good or completely unnecessary. I just had this idea when working on issue #222. :wink: Also I thought, it would be helpful to document it, regardless if this will be accepted or not. \r\n\r\n@gsakkis, @scls19fr \r\nWhat do you think? I would like to hear your opinion. :wink: \r\n\r\n","author":{"url":"https://github.com/tomschr","@type":"Person","name":"tomschr"},"datePublished":"2020-02-28T09:32:42.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":8},"url":"https://github.com/223/python-semver/issues/223"}