Skip to content

lastversion.py

This is the main module of lastversion package. To use it, import it and invoke any function documented here. For example:

from lastversion import lastversion
lastversion.has_update(repo='mautic/mautic', current_version='1.2.3')

check_version(value) ¤

Given a version string, raises argparse.ArgumentTypeError if it does not contain any version. In lastversion CLI app, this is used as argument parser helper for --newer-than (-gt) option.

Parameters:

Name Type Description Default
value str

Free-format string which is meant to contain a user-supplied version

 required

Raises:

Type Description
ArgumentTypeError

Exception in a case version was not found in the input string

Returns:

Name Type Description
Version

Parsed version object
Source code in src/lastversion/lastversion.py 
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
def check_version(value):
    """Given a version string, raises argparse.ArgumentTypeError if it does not contain any version.
    In lastversion CLI app, this is used as argument parser helper for --newer-than (-gt) option.

    Args:
        value (str): Free-format string which is meant to contain a user-supplied version

    Raises:
        argparse.ArgumentTypeError: Exception in a case version was not found in the input string

    Returns:
        Version: Parsed version object

    """
    value = parse_version(value)
    if not value:
        raise argparse.ArgumentTypeError("%s is an invalid version value" % value)
    return value

find_preferred_url(spec_urls) ¤

Given a list of URLs of a project, return preferred one that might lead to version info. Basically returns the first URL that matches a handler by matching its primary domain.

Source code in src/lastversion/lastversion.py 
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
def find_preferred_url(spec_urls):
    """
    Given a list of URLs of a project, return preferred one that might lead to version info.
    Basically returns the first URL that matches a handler by matching its primary domain.
    """
    # TODO: use rpmspec --parse if failed to get lastversion_repo inside spec (includes macro)
    for url in spec_urls:
        # parse URL and get domain
        parsed = urlparse(url)
        hostname = parsed.hostname
        # enumerate holders, and see if any of them can handle this domain
        for holder in HolderFactory.HOLDERS.values():
            if holder.DEFAULT_HOSTNAME and holder.DEFAULT_HOSTNAME == hostname:
                return url
    return spec_urls[0] if spec_urls else None

get_repo_data_from_spec(rpmspec_filename) ¤

Extracts repo data and CLI args from .spec file

The project (repo) is specified inside the .spec file GitHub repo is resolved via %{upstream_github} + %{name}/%{upstream_name} No upstream_github global means that the spec was not prepared for lastversion Optional: use of spec_tag macros if the source is from GitHub. In edge cases we check new version via GitHub, but prepared sources are elsewhere

Parameters:

Name Type Description Default
rpmspec_filename
required

Returns:

Source code in src/lastversion/lastversion.py 
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
def get_repo_data_from_spec(rpmspec_filename):
    """
    Extracts repo data and CLI args from .spec file

    The project (repo) is specified inside the .spec file
    GitHub repo is resolved via %{upstream_github} + %{name}/%{upstream_name}
    No upstream_github global means that the spec was not prepared for lastversion
    Optional: use of spec_tag macros if the source is from GitHub. In edge cases we check
    new version via GitHub, but prepared sources are elsewhere

    Args:
        rpmspec_filename:

    Returns:

    """
    repo_data = {}
    with open(rpmspec_filename) as f:
        name = None
        upstream_github = None
        upstream_name = None
        current_version = None
        spec_repo = None
        spec_urls = []
        for line in f.readlines():
            if line.startswith("%global lastversion_repo"):
                spec_repo = shlex.split(line)[2].strip()
            elif line.startswith("%global upstream_github"):
                upstream_github = shlex.split(line)[2].strip()
            elif line.startswith("%global upstream_name"):
                upstream_name = shlex.split(line)[2].strip()
            elif line.startswith("Name:"):
                name = line.split("Name:")[1].strip()
            elif line.startswith("URL:"):
                # append to spec_urls
                spec_urls.append(line.split("URL:")[1].strip())
            elif line.startswith("Source0:"):
                source0 = line.split("Source0:")[1].strip()
                # noinspection HttpUrlsUsage
                if source0.startswith("https://") or source0.startswith("http://"):
                    spec_urls.append(source0)
            elif line.startswith("%global upstream_version "):
                current_version = shlex.split(line)[2].strip()
                # influences %spec_tag to use %upstream_version instead of %version
                repo_data["module_of"] = True
            elif line.startswith("Version:") and not current_version:
                current_version = line.split("Version:")[1].strip()
            elif line.startswith("%global lastversion_only"):
                repo_data["only"] = shlex.split(line)[2].strip()
            elif line.startswith("%global lastversion_having_asset"):
                repo_data["having_asset"] = shlex.split(line)[2].strip()
            elif line.startswith("%global lastversion_major"):
                repo_data["major"] = shlex.split(line)[2].strip()

        if not current_version:
            log.critical(
                "Did not find neither Version: nor %upstream_version in the spec file"
            )
            sys.exit(1)
        try:
            if current_version != "x":
                repo_data["current_version"] = Version(current_version)
        except InvalidVersion:
            log.critical(
                "Failed to parse current version in %s. Tried %s",
                rpmspec_filename,
                current_version,
            )
            sys.exit(1)
        if upstream_name:
            repo_data["name"] = upstream_name
            repo_data["spec_name"] = "%{upstream_name}"
        else:
            repo_data["name"] = name
            repo_data["spec_name"] = "%{name}"

        if upstream_github:
            repo = f"{upstream_github}/{repo_data['name']}"
            log.info("Discovered GitHub repo %s from .spec file", repo)
        elif spec_repo:
            repo = spec_repo
            log.info("Discovered explicit repo %s from .spec file", repo)
        else:
            repo = find_preferred_url(spec_urls)

        if not repo:
            log.critical(
                "Failed to determine repo from %s. Please prepare your spec file using instructions: "
                "https://lastversion.getpagespeed.com/spec-preparing.html",
                rpmspec_filename,
            )
            sys.exit(1)

        repo_data["repo"] = repo
        return repo_data

get_repo_data_from_yml(repo) ¤

Get repo data from YAML file.

Source code in src/lastversion/lastversion.py 
157
158
159
160
161
162
163
164
165
166
167
168
def get_repo_data_from_yml(repo):
    """Get repo data from YAML file."""
    with open(repo) as fpi:
        repo_data = yaml.safe_load(fpi)
        if "repo" in repo_data:
            if "nginx-extras" in repo:
                repo_data["module_of"] = "nginx"
            name = os.path.splitext(os.path.basename(repo))[0]
            if "module_of" in repo_data:
                name = f'{repo_data["module_of"]}-module-{name}'
            repo_data["name"] = name
    return repo_data

get_rpm_packager() ¤

Get RPM packager name from ~/.rpmmacros

Source code in src/lastversion/lastversion.py 
384
385
386
387
388
389
390
391
392
393
394
def get_rpm_packager():
    """Get RPM packager name from ~/.rpmmacros"""
    try:
        rpmmacros = expanduser("~") + "/.rpmmacros"
        with open(rpmmacros) as f:
            for ln in f.readlines():
                if ln.startswith("%packager"):
                    return ln.split("%packager")[1].strip()
    except IOError:
        log.warning("~/.rpmmacros does not exist. Changelog will not be generated")
    return None

has_update(repo, current_version, pre_ok=False, at=None) ¤

Given an existing version for a repo, checks if there is an update.

Parameters:

Name Type Description Default
repo str

Repository specifier in any form.

 required
current_version str

A version you want to check update for.

 required
pre_ok bool

Specifies whether pre-releases can be accepted as a newer version.

 False
at str

Specifies repo hosting more precisely, only useful if repo argument was specified as one word.

 None

Returns:

Name Type Description
Version

Newer version as an object, if found. Otherwise, False
Source code in src/lastversion/lastversion.py 
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
def has_update(repo, current_version, pre_ok=False, at=None):
    """Given an existing version for a repo, checks if there is an update.

    Args:
        repo (str): Repository specifier in any form.
        current_version (str): A version you want to check update for.
        pre_ok (bool): Specifies whether pre-releases can be accepted as a newer version.
        at (str): Specifies repo hosting more precisely, only useful if repo argument was
                  specified as one word.

    Returns:
        Version: Newer version as an object, if found. Otherwise, False

    """
    latest_version = latest(repo, output_format="version", pre_ok=pre_ok, at=at)
    if latest_version and latest_version > Version(current_version):
        return latest_version
    return False

install_app_image(url, install_name) ¤

Install an AppImage from a URL to ~/Applications/<install_name>

Parameters:

Name Type Description Default
url str

URL where AppImage file is hosted

 required
install_name str

Short name that the AppImage will be renamed to

 required
Source code in src/lastversion/lastversion.py 
482
483
484
485
486
487
488
489
490
491
492
def install_app_image(url, install_name):
    """Install an AppImage from a URL to `~/Applications/<install_name>`

    Args:
        url (str): URL where AppImage file is hosted
        install_name (str): Short name that the AppImage will be renamed to
    """
    if not install_name.endswith(".AppImage"):
        install_name += ".AppImage"
    app_file_name = install_standalone_binary(url, install_name)
    extract_appimage_desktop_file(app_file_name)

install_release(res, args) ¤

Install latest release

Source code in src/lastversion/lastversion.py 
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
def install_release(res, args):
    """Install latest release"""
    app_images = [asset for asset in res["assets"] if asset.endswith(".AppImage")]
    if app_images:
        return install_app_image(
            app_images[0], install_name=res.get("install_name", args.repo)
        )

    rpms = [asset for asset in res["assets"] if asset.endswith(".rpm")]
    if rpms:
        return install_rpms(res, rpms, args)

    # static files are those without an extension
    static_binaries = [
        asset for asset in res["assets"] if "." not in asset.rsplit("/", 1)[-1]
    ]
    if static_binaries:
        return install_standalone_binary(
            static_binaries[0], install_name=res.get("install_name", args.repo)
        )

    log.error("No installable assets found to install")
    sys.exit(1)

install_rpms(res, rpms, args) ¤

Install RPMs using package manager

Source code in src/lastversion/lastversion.py 
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
def install_rpms(res, rpms, args):
    """Install RPMs using package manager"""
    # prevents downloading large packages if we already have newest installed
    # consult RPM database  for current version
    installed_version = rpm_installed_version(args.repo)
    if installed_version is False:
        log.warning(
            "Please install lastversion using YUM or DNF so it can check current "
            "program version. This is helpful to prevent unnecessary downloads"
        )
    if installed_version and Version(installed_version) >= Version(res["version"]):
        log.warning("Newest version %s is already installed", installed_version)
        sys.exit(0)
    # pass RPM URLs directly to package management program
    try:
        import subprocess

        params = ["yum", "install"]
        params.extend(rpms)
        if args.assumeyes:
            params.append("-y")
        subprocess.call(params)
    except OSError:
        log.critical("Failed to launch package manager. Only YUM/DNF is supported!")
        sys.exit(1)

install_standalone_binary(url, install_name) ¤

Install a standalone binary from a URL to ~/Applications/<install_name>

Parameters:

Name Type Description Default
url str

URL where the binary file is hosted

 required
install_name str

Filename that the binary will be renamed to

 required
Source code in src/lastversion/lastversion.py 
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
def install_standalone_binary(url, install_name):
    """Install a standalone binary from a URL to `~/Applications/<install_name>`

    Args:
        url (str): URL where the binary file is hosted
        install_name (str): Filename that the binary will be renamed to
    """
    home_dir = os.path.expanduser("~")
    apps_dir = os.path.join(home_dir, "Applications")
    app_file_name = os.path.join(apps_dir, install_name)

    Path(apps_dir).mkdir(exist_ok=True, parents=True)
    download_file(url, app_file_name)
    os.chmod(app_file_name, 0o755)  # skipcq: BAN-B103
    return app_file_name

latest(repo, output_format='version', pre_ok=False, assets_filter=None, short_urls=False, major=None, only=None, at=None, having_asset=None, exclude=None, even=False, formal=False) ¤

Find the latest release version for a project.

Parameters:

Name Type Description Default
major str

Only consider versions which are "descendants" of this major version string

 None
short_urls bool

Whether we should try to return shorter URLs for release data

 False
assets_filter Union[str, Pattern]

Regular expression for filtering assets for the latest release

 None
only str

Only consider tags with this text. Useful for repos with multiple projects. The argument supports negation and regular expressions. To indicate a regex, start it with tilde sign, to negate the expression, start it with exclamation point. See Examples.

 None
repo str

Repository specifier in any form.

 required
output_format str

Affects the return format. Possible values version, json, dict, assets, source, tag.

 'version'
pre_ok bool

Specifies whether pre-releases can be accepted as a newer version.

 False
at str

Specifies repo hosting more precisely, only useful if repo argument was specified as one word.

 None
having_asset Union[str, bool]

Only consider releases with the given asset. Pass True for any asset

 None
exclude str

Only consider releases NOT containing this text/regular expression.

 None
even bool

Consider as stable only releases with even minor component, e.g. 1.2.3

 False
formal bool

Consider as stable only releases with formal tags set up in Web UI

 False

Examples:

Find the latest version of Mautic, it is OK to consider betas.

>>> latest("mautic/mautic", output_format='version', pre_ok=True)
<Version('4.4.4')>

Consider only tags without letters:

>>> latest("openssl/openssl", output_format='version', only=r'!~\w')
<Version('3.0.7')>

Returns:

Type Description

Union[Version, dict]: Newer version object, if found and output_format is version.

Returns: str: Single string containing tag, if found and output_format is tag

Source code in src/lastversion/lastversion.py 
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
def latest(
    repo,
    output_format="version",
    pre_ok=False,
    assets_filter=None,
    short_urls=False,
    major=None,
    only=None,
    at=None,
    having_asset=None,
    exclude=None,
    even=False,
    formal=False,
):
    r"""Find the latest release version for a project.

    Args:
        major (str): Only consider versions which are "descendants" of this
          major version string
        short_urls (bool): Whether we should try to return shorter URLs for
          release data
        assets_filter (Union[str, Pattern]): Regular expression for filtering
          assets for the latest release
        only (str): Only consider tags with this text. Useful for repos with multiple projects.
                    The argument supports negation and regular expressions. To indicate a regex,
                    start it with tilde sign, to negate the expression, start it with exclamation
                    point. See `Examples`.
        repo (str): Repository specifier in any form.
        output_format (str): Affects the return format. Possible values `version`, `json`, `dict`,
                             `assets`, `source`, `tag`.
        pre_ok (bool): Specifies whether pre-releases can be accepted as a newer version.
        at (str): Specifies repo hosting more precisely, only useful if repo argument was
                  specified as one word.
        having_asset (Union[str, bool]): Only consider releases with the given asset.
                                         Pass `True` for any asset
        exclude (str): Only consider releases NOT containing this text/regular expression.
        even (bool): Consider as stable only releases with even minor component, e.g. 1.2.3
        formal (bool): Consider as stable only releases with formal tags set up in Web UI

    Examples:
        Find the latest version of Mautic, it is OK to consider betas.

        >>> latest("mautic/mautic", output_format='version', pre_ok=True)
        <Version('4.4.4')>

        Consider only tags without letters:

        >>> latest("openssl/openssl", output_format='version', only=r'!~\w')
        <Version('3.0.7')>

    Returns:
        Union[Version, dict]: Newer version object, if found and `output_format` is `version`.
    Returns:
        str: Single string containing tag, if found and `output_format` is `tag`

    """
    repo_data = {}

    # noinspection HttpUrlsUsage
    if repo.endswith(".yml") and not repo.startswith(("http://", "https://")):
        repo_data = get_repo_data_from_yml(repo)

    # noinspection HttpUrlsUsage
    if repo.startswith(("http://", "https://")) and repo.endswith("Chart.yaml"):
        at = "helm_chart"

    if repo.endswith(".spec"):
        repo_data = get_repo_data_from_spec(rpmspec_filename=repo)

    with HolderFactory.get_instance_for_repo(
        repo_data.get("repo", repo), at=at
    ) as project:
        project.set_only(repo_data.get("only", only))
        project.set_exclude(exclude)
        project.set_having_asset(repo_data.get("having_asset", having_asset))
        project.set_even(even)
        project.set_formal(formal)
        release = project.get_latest(pre_ok=pre_ok, major=repo_data.get("major", major))

        # bail out, found nothing that looks like a release
        if not release:
            return None

        from_type = f"Located the latest release tag {release['tag_name']} at: {project.get_canonical_link()}"
        if "type" in release:
            from_type = f"{from_type} via {release['type']} mechanism"
        log.info(from_type)

        version = release["version"]
        tag = release["tag_name"]

        # return the release if we've reached far enough:
        if output_format == "version":
            return version

        if output_format in ["json", "dict"]:
            if output_format == "dict":
                release["version"] = version
            else:
                release["version"] = str(version)
                if "tag_date" in release:
                    release["tag_date"] = str(release["tag_date"])
            release["v_prefix"] = tag.startswith("v")
            version_macro = (
                "upstream_version" if "module_of" in repo_data else "version"
            )
            version_macro = f"%{{{version_macro}}}"
            holder_i = {value: key for key, value in HolderFactory.HOLDERS.items()}
            release["source"] = holder_i[type(project)]
            release["spec_tag"] = tag.replace(str(version), version_macro)
            # spec_tag_no_prefix is the helpful macro that will allow us to know where tarball
            # extracts to (GitHub-specific)
            if release["spec_tag"].startswith(f"v{version_macro}") or re.match(
                r"^v\d", release["spec_tag"]
            ):
                release["spec_tag_no_prefix"] = release["spec_tag"].lstrip("v")
            else:
                release["spec_tag_no_prefix"] = release["spec_tag"]
            release["tag_name"] = tag
            if hasattr(project, "repo_license"):
                release["license"] = project.repo_license(tag)
            if hasattr(project, "repo_readme"):
                release["readme"] = project.repo_readme(tag)
            release.update(repo_data)
            try:
                release["assets"] = project.get_assets(
                    release, short_urls, assets_filter
                )
            except NotImplementedError:
                pass
            release["from"] = project.get_canonical_link()

            if "license" in release and release["license"]:
                spdx_id = release["license"].get("license", {}).get("spdx_id")
                rpmspec_licence = (
                    rpmspec_licenses[spdx_id] if spdx_id in rpmspec_licenses else None
                )
                if rpmspec_licence:
                    release["rpmspec_license"] = rpmspec_licence

            release["source_url"] = project.release_download_url(release, short_urls)

            return release

        if output_format == "assets":
            return project.get_assets(release, short_urls, assets_filter)

        if output_format == "source":
            return project.release_download_url(release, short_urls)

        if output_format == "tag":
            return tag

    return None

parse_version(tag) ¤

Parse version to a Version object. Argument may not be a version but a URL or a repo name, in which case return False E.g., used in lastversion repo-name -gt 1.2.3 (and repo-name is passed here as tag)

Source code in src/lastversion/lastversion.py 
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
def parse_version(tag):
    """
    Parse version to a Version object.
    Argument may not be a version but a URL or a repo name, in which case return False
    E.g., used in lastversion repo-name -gt 1.2.3 (and repo-name is passed here as tag)
    """
    # If a URL is passed
    if tag.startswith(("http://", "https://")):
        return False
    # If a repo name is passed, e.g. "mautic/mautic"
    if "/" in tag and " " not in tag:
        return False
    h = TestProjectHolder()
    v = h.sanitize_version(tag, pre_ok=True)
    return v