python/openapi/src/com/jetbrains/python/packaging/PyPackageManagers.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

/*
 * Copyright 2000-2013 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.jetbrains.python.packaging;

import com.intellij.openapi.components.ServiceManager;
import com.intellij.openapi.module.Module;
import com.intellij.openapi.projectRoots.Sdk;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.List;

/**
 * @author yole
 */
public abstract class PyPackageManagers {

  @NotNull
  public static PyPackageManagers getInstance() {
    return ServiceManager.getService(PyPackageManagers.class);
  }

  @NotNull
  public abstract PyPackageManager forSdk(Sdk sdk);

  /**
   * Returns the list of requirements from 'requirements.txt' or 'setup.py' files in the specified module.
   *
   * @param module the module to check for requirements
   * @return the list of requirements, or null if the module contains neither requirements.txt nor setup.py.
   */
  @Nullable
  public abstract List<PyRequirement> getRequirements(Module module);

  /**
   * Returns the list of requirements from 'requirements.txt' file in the specified module.
   *
   * @param module the module to check for requirements
   * @return the list of requirements, or null if the module does not contain a requirements.txt
   */
  @Nullable
  public abstract List<PyRequirement> getRequirementsFromTxt(Module module);
}