Skip to content

Commit

Permalink
refactor(datasource/pypi): rename normalization function (#28584)
Browse files Browse the repository at this point in the history
  • Loading branch information
not7cd committed Apr 22, 2024
1 parent 53cf289 commit dbd17ed
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion lib/modules/datasource/pypi/common.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ export function isGitHubRepo(url: string): boolean {
}

// https://packaging.python.org/en/latest/specifications/name-normalization/
export function normalizeDepName(name: string): string {
export function normalizePythonDepName(name: string): string {
return name.replace(/[-_.]+/g, '-').toLowerCase();
}
6 changes: 3 additions & 3 deletions lib/modules/datasource/pypi/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { ensureTrailingSlash } from '../../../util/url';
import * as pep440 from '../../versioning/pep440';
import { Datasource } from '../datasource';
import type { GetReleasesConfig, Release, ReleaseResult } from '../types';
import { isGitHubRepo, normalizeDepName } from './common';
import { isGitHubRepo, normalizePythonDepName } from './common';
import type { PypiJSON, PypiJSONRelease, Releases } from './types';

export class PypiDatasource extends Datasource {
Expand Down Expand Up @@ -85,7 +85,7 @@ export class PypiDatasource extends Datasource {
): Promise<ReleaseResult | null> {
const lookupUrl = url.resolve(
hostUrl,
`${normalizeDepName(packageName)}/json`,
`${normalizePythonDepName(packageName)}/json`,
);
const dependency: ReleaseResult = { releases: [] };
logger.trace({ lookupUrl }, 'Pypi api got lookup');
Expand Down Expand Up @@ -223,7 +223,7 @@ export class PypiDatasource extends Datasource {
): Promise<ReleaseResult | null> {
const lookupUrl = url.resolve(
hostUrl,
ensureTrailingSlash(normalizeDepName(packageName)),
ensureTrailingSlash(normalizePythonDepName(packageName)),
);
const dependency: ReleaseResult = { releases: [] };
const response = await this.http.get(lookupUrl);
Expand Down
10 changes: 5 additions & 5 deletions lib/modules/manager/pip-compile/extract.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import upath from 'upath';
import { logger } from '../../../logger';
import { readLocalFile } from '../../../util/fs';
import { ensureLocalPath } from '../../../util/fs/util';
import { normalizeDepName } from '../../datasource/pypi/common';
import { normalizePythonDepName } from '../../datasource/pypi/common';
import { extractPackageFile as extractRequirementsFile } from '../pip_requirements/extract';
import { extractPackageFile as extractSetupPyFile } from '../pip_setup';
import type {
Expand Down Expand Up @@ -179,8 +179,8 @@ export async function extractAllPackageFiles(
for (const dep of packageFileContent.deps) {
const lockedVersion = lockedDeps?.find(
(lockedDep) =>
normalizeDepName(lockedDep.depName!) ===
normalizeDepName(dep.depName!),
normalizePythonDepName(lockedDep.depName!) ===
normalizePythonDepName(dep.depName!),
)?.currentVersion;
if (lockedVersion) {
dep.lockedVersion = lockedVersion;
Expand Down Expand Up @@ -260,8 +260,8 @@ function extendWithIndirectDeps(
if (
!packageFileContent.deps.find(
(dep) =>
normalizeDepName(lockedDep.depName!) ===
normalizeDepName(dep.depName!),
normalizePythonDepName(lockedDep.depName!) ===
normalizePythonDepName(dep.depName!),
)
) {
packageFileContent.deps.push(indirectDep(lockedDep));
Expand Down
4 changes: 2 additions & 2 deletions lib/modules/manager/poetry/schema.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { GitTagsDatasource } from '../../datasource/git-tags';
import { GithubTagsDatasource } from '../../datasource/github-tags';
import { GitlabTagsDatasource } from '../../datasource/gitlab-tags';
import { PypiDatasource } from '../../datasource/pypi';
import { normalizeDepName } from '../../datasource/pypi/common';
import { normalizePythonDepName } from '../../datasource/pypi/common';
import * as gitVersioning from '../../versioning/git';
import * as pep440Versioning from '../../versioning/pep440';
import * as poetryVersioning from '../../versioning/poetry';
Expand Down Expand Up @@ -158,7 +158,7 @@ export const PoetryDependencies = LooseRecord(
for (const [depName, dep] of Object.entries(record)) {
dep.depName = depName;
if (!dep.packageName) {
const packageName = normalizeDepName(depName);
const packageName = normalizePythonDepName(depName);
if (depName !== packageName) {
dep.packageName = packageName;
}
Expand Down
6 changes: 3 additions & 3 deletions lib/workers/repository/init/vulnerability.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { NpmDatasource } from '../../../modules/datasource/npm';
import { NugetDatasource } from '../../../modules/datasource/nuget';
import { PackagistDatasource } from '../../../modules/datasource/packagist';
import { PypiDatasource } from '../../../modules/datasource/pypi';
import { normalizeDepName } from '../../../modules/datasource/pypi/common';
import { normalizePythonDepName } from '../../../modules/datasource/pypi/common';
import { RubyGemsDatasource } from '../../../modules/datasource/rubygems';
import { platform } from '../../../modules/platform';
import * as allVersioning from '../../../modules/versioning';
Expand Down Expand Up @@ -221,9 +221,9 @@ export async function detectVulnerabilityAlerts(
};
if (
datasource === PypiDatasource.id &&
normalizeDepName(depName) !== depName
normalizePythonDepName(depName) !== depName
) {
matchRule.matchPackageNames?.push(normalizeDepName(depName));
matchRule.matchPackageNames?.push(normalizePythonDepName(depName));
}
const supportedRemediationFileTypes = ['package-lock.json'];
if (
Expand Down

0 comments on commit dbd17ed

Please sign in to comment.