René's URL Explorer Experiment


Title: python-api/docs/reference.rst at python3-syntax · mathbou/python-api · GitHub

Open Graph Title: python-api/docs/reference.rst at python3-syntax · mathbou/python-api

X Title: python-api/docs/reference.rst at python3-syntax · mathbou/python-api

Description: A Python-based API for accessing ShotGrid. Contribute to mathbou/python-api development by creating an account on GitHub.

Open Graph Description: A Python-based API for accessing ShotGrid. Contribute to mathbou/python-api development by creating an account on GitHub.

X Description: A Python-based API for accessing ShotGrid. Contribute to mathbou/python-api development by creating an account on GitHub.

Opengraph URL: https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst

X: @github

direct link

Domain: github.com

route-pattern/:user_id/:repository/blob/*name(/*path)
route-controllerblob
route-actionshow
fetch-noncev2:f1d43910-0e2c-5328-3b71-7069da1f95b2
current-catalog-service-hashf3abb0cc802f3d7b95fc8762b94bdcb13bf39634c40c357301c4aa1d67a256fb
request-idAAD4:3A401E:922E8:C4116:6A527DD3
html-safe-noncec918eacd49efb374e0bd0b11da6773aa6df077f007228b6f9fb6f0bad231c0f5
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBQUQ0OjNBNDAxRTo5MjJFODpDNDExNjo2QTUyN0REMyIsInZpc2l0b3JfaWQiOiI0NDk1NjAzNTIxMDM1NTk5MzE1IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0=
visitor-hmacc9fcbd7922110c8ae71471dc4c8aff7dd7983ea1ecb9a1f7574194db2a11d0ad
hovercard-subject-tagrepository:681368882
github-keyboard-shortcutsrepository,source-code,file-tree,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///blob/show
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst
twitter:imagehttps://opengraph.githubassets.com/a07dc1697e85dadac79ff21504793fb8d6f1c770514f9bcb5b29ebf30c41b370/mathbou/python-api
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/a07dc1697e85dadac79ff21504793fb8d6f1c770514f9bcb5b29ebf30c41b370/mathbou/python-api
og:image:altA Python-based API for accessing ShotGrid. Contribute to mathbou/python-api development by creating an account on GitHub.
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
hostnamegithub.com
expected-hostnamegithub.com
Noneb9a586c06a05a7a86fc7e3f4dbd03e42f6869085879aa184aa6369456dbd50fb
turbo-cache-controlno-cache
go-importgithub.com/mathbou/python-api git https://github.com/mathbou/python-api.git
octolytics-dimension-user_id13415583
octolytics-dimension-user_loginmathbou
octolytics-dimension-repository_id681368882
octolytics-dimension-repository_nwomathbou/python-api
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forktrue
octolytics-dimension-repository_parent_id748742
octolytics-dimension-repository_parent_nwoshotgunsoftware/python-api
octolytics-dimension-repository_network_root_id748742
octolytics-dimension-repository_network_root_nwoshotgunsoftware/python-api
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release07a982c1d40157c619b364352b704c3ce66bb332
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#start-of-content
https://github.com/
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmathbou%2Fpython-api%2Fblob%2Fpython3-syntax%2Fdocs%2Freference.rst
GitHub CopilotWrite better code with AIhttps://github.com/features/copilot
GitHub Copilot appDirect agents from issue to mergehttps://github.com/features/ai/github-app
MCP RegistryNewIntegrate external toolshttps://github.com/mcp
ActionsAutomate any workflowhttps://github.com/features/actions
CodespacesInstant dev environmentshttps://github.com/features/codespaces
IssuesPlan and track workhttps://github.com/features/issues
Code ReviewManage code changeshttps://github.com/features/code-review
GitHub Advanced SecurityFind and fix vulnerabilitieshttps://github.com/security/advanced-security
Code securitySecure your code as you buildhttps://github.com/security/advanced-security/code-security
Secret protectionStop leaks before they starthttps://github.com/security/advanced-security/secret-protection
Why GitHubhttps://github.com/why-github
Documentationhttps://docs.github.com
Bloghttps://github.blog
Changeloghttps://github.blog/changelog
Marketplacehttps://github.com/marketplace
View all featureshttps://github.com/features
Enterpriseshttps://github.com/enterprise
Small and medium teamshttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
App Modernizationhttps://github.com/solutions/use-case/app-modernization
DevSecOpshttps://github.com/solutions/use-case/devsecops
DevOpshttps://github.com/solutions/use-case/devops
CI/CDhttps://github.com/solutions/use-case/ci-cd
View all use caseshttps://github.com/solutions/use-case
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
View all industrieshttps://github.com/solutions/industry
View all solutionshttps://github.com/solutions
AIhttps://github.com/resources/articles?topic=ai
Software Developmenthttps://github.com/resources/articles?topic=software-development
DevOpshttps://github.com/resources/articles?topic=devops
Securityhttps://github.com/resources/articles?topic=security
View all topicshttps://github.com/resources/articles
Customer storieshttps://github.com/customer-stories
Events & webinarshttps://github.com/resources/events
Ebooks & reportshttps://github.com/resources/whitepapers
Business insightshttps://github.com/solutions/executive-insights
GitHub Skillshttps://skills.github.com
Documentationhttps://docs.github.com
Customer supporthttps://support.github.com
Community forumhttps://github.com/orgs/community/discussions
Trust centerhttps://github.com/trust-center
Partnershttps://github.com/partners
View all resourceshttps://github.com/resources
GitHub SponsorsFund open source developershttps://github.com/open-source/sponsors
Security Labhttps://securitylab.github.com
Maintainer Communityhttps://maintainers.github.com
Acceleratorhttps://github.com/open-source/accelerator
GitHub Starshttps://stars.github.com
Archive Programhttps://archiveprogram.github.com
Topicshttps://github.com/topics
Trendinghttps://github.com/trending
Collectionshttps://github.com/collections
Enterprise platformAI-powered developer platformhttps://github.com/enterprise
GitHub Advanced SecurityEnterprise-grade security featureshttps://github.com/security/advanced-security
Copilot for BusinessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Pricinghttps://github.com/pricing
Search syntax tipshttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
documentationhttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmathbou%2Fpython-api%2Fblob%2Fpython3-syntax%2Fdocs%2Freference.rst
Sign up https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fblob%2Fshow&source=header-repo&source_repo=mathbou%2Fpython-api
Reloadhttps://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst
Reloadhttps://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst
Reloadhttps://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst
mathbou https://github.com/mathbou
python-apihttps://github.com/mathbou/python-api
shotgunsoftware/python-apihttps://github.com/shotgunsoftware/python-api
Notifications https://github.com/login?return_to=%2Fmathbou%2Fpython-api
Fork 0 https://github.com/login?return_to=%2Fmathbou%2Fpython-api
Star 0 https://github.com/login?return_to=%2Fmathbou%2Fpython-api
Code https://github.com/mathbou/python-api/tree/python3-syntax
Pull requests 0 https://github.com/mathbou/python-api/pulls
Actions https://github.com/mathbou/python-api/actions
Projects https://github.com/mathbou/python-api/projects
Security and quality 0 https://github.com/mathbou/python-api/security
Insights https://github.com/mathbou/python-api/pulse
Code https://github.com/mathbou/python-api/tree/python3-syntax
Pull requests https://github.com/mathbou/python-api/pulls
Actions https://github.com/mathbou/python-api/actions
Projects https://github.com/mathbou/python-api/projects
Security and quality https://github.com/mathbou/python-api/security
Insights https://github.com/mathbou/python-api/pulse
https://github.com/mathbou/python-api
python-apihttps://github.com/mathbou/python-api/tree/python3-syntax
docshttps://github.com/mathbou/python-api/tree/python3-syntax/docs
Historyhttps://github.com/mathbou/python-api/commits/python3-syntax/docs/reference.rst
https://github.com/mathbou/python-api/commits/python3-syntax/docs/reference.rst
python-apihttps://github.com/mathbou/python-api/tree/python3-syntax
docshttps://github.com/mathbou/python-api/tree/python3-syntax/docs
Rawhttps://github.com/mathbou/python-api/raw/refs/heads/python3-syntax/docs/reference.rst
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#api-reference
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#shotgun-module-attributes
:mod:`~shotgun_api3.shotgun`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id1
:class:`~shotgun.Shotgun`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id3
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#shotgun
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#shotgrid-methods
:class:`~shotgun_api3.Shotgun`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id5
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#connection--authentication
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#crud-methods
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#working-with-files
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#activity-stream
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#working-with-the-shotgrid-schema
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#exceptions
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#filter-syntax
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#basic-filters
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#basic-example
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#complex-filters
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#complex-example
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#operators-and-arguments
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#valid-operators-by-data-type
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#additional-filter-presets
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#example-uses
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#available-filter-presets-by-entity-type
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#data-types
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#addressing
:obj:`list`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id10
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#checkbox
:obj:`bool`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id12
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#color
:obj:`str`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id14
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#currency
:obj:`float`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id16
:obj:`None`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id18
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#date
:obj:`str`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id20
:obj:`None`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id22
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#date_time
:mod:`datetime`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id24
:obj:`None`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id26
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#duration
:obj:`int`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id28
:obj:`None`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id30
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#entity
:obj:`dict`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id32
:obj:`None`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id34
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#float
:obj:`float`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id36
:obj:`None`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id38
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#footage
:obj:`str`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id40
:obj:`None`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id42
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#image-read-only
:obj:`str`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id44
:obj:`None`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id46
:ref:`interpreting_image_field_strings`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id48
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#list
:obj:`str`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id50
:obj:`None`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id52
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#multi_entity
:obj:`list`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id54
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#number
:obj:`int`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id56
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#password
:obj:`string`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id58
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#percent
:obj:`int`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id60
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#serializable
:obj:`dict`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id62
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#status_list
:obj:`str`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id64
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#system_task_type-deprecated
:obj:`str`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id66
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#tag_list
:obj:`list`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id68
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#text
:obj:`str`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id70
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#timecode
:obj:`int`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id72
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#url-filelink-field
:obj:`dict`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id74
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#local-file-links
:obj:`dict`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id76
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#interpreting-image-field-strings
:obj:`None`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id79
:obj:`str`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id81
:obj:`str`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id83
https://my-site.shotgrid.autodesk.com/images/status/transient/https://my-site.shotgrid.autodesk.com/images/status/transient/
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#event-types
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#event-based-triggers
ShotGrid Event Daemonhttps://github.com/shotgunsoftware/shotgunEvents
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#structure-of-event-types
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#standard-event-types
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#additional-event-types
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#custom-event-types
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#performance
reach out to our support teamhttps://developer.shotgridsoftware.com
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#environment-variables
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#shotgun_api_cacerts
:class:`~shotgun.Shotgun`https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#id86
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#shotgun_api_retry_interval
https://github.com/mathbou/python-api/blob/python3-syntax/docs/reference.rst#localization
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width

URLs of crawlers that visited me.