Inline PythonScript Azure Pipelines task in external file

Question

I am developing a Azure task template, and I have a large .py file that I want to be executed in one step

  - task: PythonScript@0
    displayName: 'Run a Python script'
    inputs:
      scriptSource: inline
      script: |
        ... really long python code

It's possible to store the code in another file, at the same level of the yml template, and consume it from there? Or what would be the best approach to keep the template clean?

I know that it's possible to use scriptSource

  - task: PythonScript@0
    displayName: 'Run a Python script'
    inputs:
      scriptSource: 'filePath'
      scriptPath: 'my_python.py'
      arguments: '${{ parameters.my_param }}'

But as the template is in another repository than the repository ran in the pipeline, I don't think that I can reach that my_python.py without downloading it with a wget, or cloning, or doing additional steps. I am right?

Regards!

Hi @Del . Is there any update about this ticket? If Krzysztof Madej's answer could solve this issue, you may consider accepting it as answer. This will be helpful to other users — Kevin Lu
– Kevin Lu, Commented Mar 19, 2021 at 7:16

Krzysztof Madej · Accepted Answer · 2021-03-16 13:52:52Z

1

To use a template from another repo you need to define repository source like here:

# Repo: Contoso/LinuxProduct
# File: azure-pipelines.yml
resources:
  repositories:
    - repository: templates
      type: github
      name: Contoso/BuildTemplates

steps:
- template: common.yml@templates  # Template reference

Once you have you need to just checkout this repo:

# Repo: Contoso/LinuxProduct
# File: azure-pipelines.yml
resources:
  repositories:
    - repository: templates
      type: github
      name: Contoso/BuildTemplates

steps:
- checkout: self
- checkout: templates #this download whole repo
- template: common.yml@templates  # Template reference

Now you need to figure out where it is downloaded ;)

Multiple repositories: If you have multiple checkout steps in your job, your source code is checked out into directories named after the repositories as a subfolder of s in (Agent.BuildDirectory). If (Agent.BuildDirectory) is C:\agent\_work\1 and your repositories are named tools and code, your code is checked out to C:\agent\_work\1\s\tools and C:\agent\_work\1\s\code.

So if you have script in scripts folder in templates repo you will find it in $(Agent.BuildDirectory)\templates\scripts\script.py.

So then you can use it like this:

  - task: PythonScript@0
    displayName: 'Run a Python script'
    inputs:
      scriptSource: 'filePath'
      scriptPath: '$(Agent.BuildDirectory)\templates\scripts\script.py'
      arguments: '${{ parameters.my_param }}'

answered Mar 16, 2021 at 13:52

Krzysztof Madej

42.1k10 gold badges117 silver badges141 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

John Scott Stensland Over a year ago

the OP is asking to have his template refer to a python script which lives in the template repo ... your bottom most code snippet suggests code you put into the client pipeline because you mention templates which you define only in client pipeline ... however the OP wants to avoid the client pipeline from seeing that underlying python script .... goal of OP is to hide inside the template all dealings with the python ... please update

Collectives™ on Stack Overflow

Inline PythonScript Azure Pipelines task in external file

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related