How to create a Windows Service in Python

Hi guys, today’s post is just for the ones of you that work with the “OS of the misoriented slashes”: Microsoft Windows. 🙂

Have you ever had the need of writing a Python script that could run in background as a Windows Service? In this post, you will learn how to do it in less than 10 minutes, no jokes.

I will skip all the introduction about Windows Services, how convenient they could be, how much could be appreciated the fact that they can be run in background even when the user is logged off etc… I mean, if you can code in Python and you use Windows I bet you already know what a Windows Service is, don’t you?

So, first of all, let’s start by installing the Python for Windows extensions:

Once you have done it, let’s write this base class, your Windows service will be a subclass of this base class.

Let’s examine the class we have just introduced a little.

def SvcDoRun(self): it’s the method that will be called when the service is requested to start.

def SvcStop(self): it’s the method that will be called when the service is requested to stop.

def start(self): it’s a method that you will be asked to override if you need to do something when the service is starting (before started)

def stop(self): it’s the method that you will be asked to override if you need to do something when the service is stopping (before stopped)

def main(self): it’s the method that will contain the logic of your script, usually in a loop that keeps it alive until the service is stopped.

def parse_command_line(cls): it’s the method that handles the command line interface that you can use to install and update your windows service

Can you see how easy it is with pywin32 to interface with the system to create a Windows Service? The last mention is for the following variables:

These are just three variables that contain the name of the service, the “friendly name” that will be used by Windows to display the name on the mmc console and a short description of your service.

As always, enough talk, let’s code something useful!

Let’s pretend that we want to create a Winservice that, when started, creates a random file on our C: drive every 5 seconds.

What? Do you think it is stupid? Well, install it on your boss PC, set the destination folder as its user’s desktop and you will change your mind. 🙂

However, how can you achieve this result? Super easy.

• Subclass the SMWinservice class we have just met.
• On the new class, override the three variables _svc_name_, _svc_display_name_ and _svc_description_.
• Override the “start” method to set the running condition. Setting a boolean variable will be enough for that.
• Override the “stop” method to invalidate the running condition when the service is requested to be stopped.
• Override the “main” method to add the logic of creating a random file every 5 seconds
• Add the call at the “parse_command_line” function to handle the command line interface.

The result should be something like this:

That’s it! Now it’s time to install our newly created winservice. Just open a command prompt, navigate to your script directory and install the service with the command:

In the future, if you want to change the code of your service, just modify it and reinstall the service with

Now, open the “Services” msc snap in

locate your new PythonCornerExample winservice, and right click and choose properties. Here you can start your service and configure it at your will.

Now try to start your service and go to see your C: folder contents.

Can you see all these files being created to your C: folder? Yeah, that’s working!

But now it’s time to stop it! 🙂 You can do it from the previous windows or just by using the command line

If something goes wrong…

There are a couple of known problems that can happen writing Windows Services in Python. If you have successfully installed the service but starting it you get an error, follow this iter to troubleshoot your service:

• Check if Python is in your PATH variable. It MUST be there. To check this, just open a command prompt and try starting the python interpreter by typing “python”. If it starts, you are ok.
• Be sure to have the file C:\Program Files\Python36\Lib\site-packages\win32\pywintypes36.dll (please note that “36” is the version of your Python installation). If you don’t have this file, take it from C:\Program Files\Python36\Lib\site-packages\pywin32_system32\pywintypes36.dll and copy it into C:\Program Files\Python36\Lib\site-packages\win32

If you still have problems, try executing your Python script in debug mode. To try this with our previous example, open a terminal, navigate to the directory where the script resides and type

Ok, that’s all for today, this was just a brief introduction to developing Windows Services with Python. Try it by yourself and … happy coding!

Did you find this article helpful?

Buy me a coffee!

Создание службы Windows с использованием Python

Введение

Примеры

Скрипт Python, который можно запустить как сервис

Модули , используемые в данном примере , являются частью pywin32 (Python для расширений Windows). В зависимости от того, как вы установили Python, вам может потребоваться установить его отдельно.

Это просто шаблон. Код вашего приложения, вероятно, вызывающий отдельный скрипт, будет идти в функцию main ().

Вам также нужно будет установить это как сервис. Лучшее решение для этого в данный момент , как представляется, использовать Non-сосущий Service Manager . Это позволяет установить службу и предоставляет графический интерфейс для настройки командной строки, которую выполняет служба. Для Python вы можете сделать это, что создает сервис за один раз:

Где my_script.py — это приведенный выше шаблон сценария, измененный для вызова сценария приложения или кода в функции main (). Обратите внимание, что сервис не запускает скрипт Python напрямую, он запускает интерпретатор Python и передает ему основной скрипт в командной строке.

В качестве альтернативы вы можете использовать инструменты, предоставленные в Windows Server Resource Kit для вашей версии операционной системы, поэтому создайте службу.

Запуск веб-приложения Flask в качестве службы

Это вариант общего примера. Вам просто нужно импортировать приложение сценарий и вызвать это run() метод в сервисе main() функции. В этом случае мы также используем многопроцессорной модуль из — за проблемы с доступом WSGIRequestHandler .

Взято из https://codecamp.ru/a/25130524/318488

Синтаксис

Параметры

Примечания

Научим основам Python и Data Science на практике

Это не обычный теоритический курс, а онлайн-тренажер, с практикой на примерах рабочих задач, в котором вы можете учиться в любое удобное время 24/7. Вы получите реальный опыт, разрабатывая качественный код и анализируя реальные данные.

Как запустить сценарий Python в качестве службы в Windows?

Я делаю набросок архитектуры набора программ, которые совместно используют различные взаимосвязанные объекты, хранящиеся в базе данных. Я хочу, чтобы одна из программ действовала как служба, обеспечивающая интерфейс более высокого уровня для операций с этими объектами, а другие программы — для доступа к объектам через эту службу.

В настоящее время я стремлюсь к Python и фреймворку Django в качестве технологий для реализации этой службы. Я почти уверен, что понимаю, как демонизировать программу Python в Linux. Однако это необязательный элемент спецификации, что система должна поддерживать Windows. У меня мало опыта программирования для Windows и вообще нет опыта работы со службами Windows.

Можно ли запускать программы Python как службу Windows (т.е. запускать ее автоматически без входа пользователя в систему)? Мне не обязательно реализовывать эту часть, но мне нужно общее представление о том, как это будет сделано, чтобы решить, следует ли проектировать в соответствии с этими направлениями.

Изменить: Спасибо за все ответы, они довольно исчерпывающие. Я хотел бы узнать еще кое-что: как Windows узнает о моей службе? Могу ли я управлять этим с помощью родных утилит Windows? Что эквивалентно помещению сценария запуска / остановки в /etc/init.d?

Да, ты можешь. Я делаю это с помощью библиотек pythoncom, которые входят в состав ActivePython или могут быть установлены с pywin32 (расширения Python для Windows).

Это базовый скелет для простого сервиса:

Ваш код войдет в main() метод — обычно с каким-то бесконечным циклом, который может быть прерван проверкой флага, установленного вами в SvcStop методе

Хотя пару недель назад я поддержал выбранный ответ, тем временем я еще больше боролся с этой темой. Похоже, что иметь специальную установку Python и использовать специальные модули для запуска скрипта как службы — это просто неправильный путь. Что насчет портативности и тому подобного?

Я наткнулся на замечательный Non-sucking Service Manager , который сделал работу со службами Windows действительно простой и разумной. Я подумал, что, поскольку я могу передавать параметры установленной службе, я могу с таким же успехом выбрать исполняемый файл Python и передать свой скрипт в качестве опции.

Я еще не пробовал это решение, но сделаю это прямо сейчас и буду обновлять этот пост в процессе. Я также заинтересован в использовании virtualenvs в Windows, поэтому рано или поздно я могу придумать учебник и дать ссылку на него здесь.

Самый простой способ — использовать: NSSM — Non-Sucking Service Manager. Просто скачайте и разархивируйте в любое место по вашему выбору. Это автономная утилита, около 300 КБ (намного меньше, чем установка всего пакета pywin32 только для этой цели), и никакой «установки» не требуется. Архив содержит 64-битную и 32-битную версии утилиты. Любой из них должен хорошо работать в текущих системах (вы можете использовать 32-битную версию для управления службами в 64-битных системах).

GUI подход

1 — установить программу python как службу. Откройте приглашение Win от имени администратора

2 — На консоли GUI NSSM:

путь: C: \ Python27 \ Python27.exe

Каталог запуска: C: \ Python27

Аргументы: c: \ WinService.py

3 — проверьте созданные сервисы на services.msc

Подход к написанию сценариев (без графического интерфейса)

Это удобно, если ваша служба должна быть частью автоматизированной, неинтерактивной процедуры, которая может находиться вне вашего контроля, например, пакетного сценария или сценария установки. Предполагается, что команды выполняются с правами администратора.

Для удобства команды описаны здесь, просто указав утилиту как nssm.exe . Тем не менее, рекомендуется более явно ссылаться на него в сценариях с полным путем c:\path\to\nssm.exe , поскольку это автономный исполняемый файл, который может находиться на частном пути, о котором система не знает.

1. Установите службу

Вы должны указать имя службы, путь к соответствующему исполняемому файлу Python и путь к скрипту:

В качестве альтернативы вы можете захотеть, чтобы ваше приложение Python запускалось как модуль Python. Один из простых подходов — сообщить nssm, что ему необходимо перейти в правильный стартовый каталог, как вы сделали бы сами при запуске из командной оболочки:

Этот подход хорошо работает с виртуальными средами и автономными (встроенными) установками Python. Просто убедитесь, что вы правильно решили все проблемы с путями в этих средах с помощью обычных методов. nssm может при необходимости устанавливать переменные среды (например, PYTHONPATH), а также запускать пакетные сценарии.

2. Для запуска службы

3. Чтобы остановить службу

4. Чтобы удалить службу , укажите confirm параметр, чтобы пропустить интерактивное подтверждение.

Существует несколько альтернатив для установки в качестве службы практически любого исполняемого файла Windows.

Способ 1. Используйте instsrv и srvany из rktools.exe

Для Windows Home Server или Windows Server 2003 (также работает с WinXP) Windows Server 2003 Resource Kit Tools поставляется с утилитами, которые можно использовать в тандеме для этого, под названием instsrv.exe и srvany.exe . См. Эту статью базы знаний Майкрософт KB137890 для получения подробной информации о том, как использовать эти утилиты.

Для Windows Home Server есть отличная удобная оболочка для этих утилит под названием « Any Service Installer ».

Метод 2: используйте ServiceInstaller для Windows NT

Существует еще одна альтернатива с использованием ServiceInstaller для Windows NT (которую можно загрузить здесь ) с доступными инструкциями на языке Python . Вопреки названию, он работает как с Windows 2000, так и с Windows XP. Вот несколько инструкций по установке скрипта Python в качестве службы.

Установка скрипта Python

Запустите ServiceInstaller, чтобы создать новую службу. (В этом примере предполагается, что python установлен в c: \ python25)

После установки откройте приложение «Службы» панели управления, выберите и запустите службу PythonTest.

После своего первоначального ответа я заметил, что на SO уже были опубликованы тесно связанные вопросы и ответы. Смотрите также:

Самый простой способ добиться этого — использовать встроенную команду sc.exe:

Ссылки:

Пошаговое объяснение, как заставить его работать:

1- Сначала создайте файл python в соответствии с основным скелетом, упомянутым выше. И сохраните его по пути, например: «c: \ PythonFiles \ AppServerSvc.py»

2 — На этом шаге мы должны зарегистрировать нашу службу.

Запустите командную строку от имени администратора и введите:

sc create TestService binpath = «C: \ Python36 \ Python.exe c: \ PythonFiles \ AppServerSvc.py» DisplayName = «TestService» start = auto

первый аргумент binpath — это путь к python.exe

второй аргумент binpath — это путь к вашему файлу python, который мы уже создали

Не упустите возможность ставить один пробел после каждого знака » = «.

Тогда, если все в порядке, вы должны увидеть

Теперь ваша служба Python установлена ​​как служба Windows. Вы можете увидеть это в Service Manager и в реестре в разделе:

HKEY_LOCAL_MACHINE \ SYSTEM \ CurrentControlSet \ Services \ TestService

3- Хорошо. Вы можете запустить свою службу в диспетчере служб.

Вы можете выполнить любой файл python, который предоставляет этот скелет службы.

Пример сценария для запуска как службы, взятый с pythonhosted.org :

Создать и запустить сервис

Остановить и удалить службу

nssm в Python 3+

(Я преобразовал свой файл .py в .exe с помощью pyinstaller )

nssm: как было сказано ранее

запустите nssm install

На консоли NSSM:

путь: путь \ к \ вашей \ программе.exe

Каталог запуска: путь \ to \ your \ # такой же, как путь, но без вашего program.exe

Аргументы: пусто

Если вы не хотите конвертировать свой проект в .exe

• создать файл .bat с python <>
• и установите путь к файлу .bat

Я начал хостинг как услугу с pywin32 .

Все было хорошо, но я столкнулся с проблемой, что служба не могла запуститься в течение 30 секунд (тайм-аут по умолчанию для Windows) при запуске системы. Для меня это было критично, потому что запуск Windows происходил одновременно на нескольких виртуальных машинах, размещенных на одной физической машине, и нагрузка ввода-вывода была огромной. Сообщения об ошибках были:

Error 1053: The service did not respond to the start or control request in a timely fashion.

Error 7009: Timeout (30000 milliseconds) waiting for the service to connect.

Я много боролся с pywin, но в итоге использовал NSSM, как было предложено в этом ответе . На него было очень легко перейти.

Полный пример pywin32 с использованием цикла или подпотока

Поработав над этим в течение нескольких дней, вот ответ, который я хотел бы найти, используя pywin32, чтобы он оставался красивым и самодостаточным.

Это полный рабочий код для решения на основе одного цикла и одного потока. Он может работать как на python 2, так и на 3, хотя я тестировал только последнюю версию на 2.7 и Win7. Цикл должен подходить для кода опроса, а протектор должен работать с кодом, более похожим на сервер. Кажется, он прекрасно работает с wsgi-сервером официантки , у которого нет стандартного способа корректного завершения работы.

Я также хотел бы отметить, что, похоже, существует множество примеров, подобных этому , которые почти полезны, но на самом деле вводят в заблуждение, потому что они слепо вырезали и вставляли другие примеры. Я могу ошибаться. но зачем создавать событие, если вы его никогда не ждете?

Тем не менее, я все еще чувствую, что я здесь несколько шатко, особенно в отношении того, насколько чистым является выход из версии потока, но, по крайней мере, я считаю, что здесь нет ничего вводящего в заблуждение .

Для запуска просто скопируйте код в файл и следуйте инструкциям.

Обновить:

Используйте простой флаг для завершения потока. Важным моментом является то, что печать «нить сделана».
Более подробный пример выхода из потока неконтролируемого сервера см. В моем сообщении о wsgi-сервере официантки .

Принятый ответ с использованием win32serviceutil работает, но сложен и усложняет отладку и внесение изменений. Это гораздо проще в использовании NSSM ( Не-сосание Service Manager) . Вы пишете и с комфортом отлаживаете обычную программу на Python, и когда она наконец заработает, вы используете NSSM, чтобы установить ее как службу менее чем за минуту:

Вы запускаете командную строку с повышенными правами (администратор) nssm.exe install NameOfYourService и вводите следующие параметры:

• путь : (например, путь к python.exe C:\Python27\Python.exe )
• Аргументы : (например, путь к вашему скрипту python c:\path\to\program.py )

Кстати, если ваша программа печатает полезные сообщения, которые вы хотите сохранить в файле журнала, NSSM также может обработать это и многое другое за вас.

Этот ответ является плагиатором из нескольких источников на StackOverflow — большинство из них указано выше, но я забыл о других — извините. Это просто, и сценарии работают «как есть». Для выпусков вы тестируете сценарий, затем копируете его на сервер и останавливаете / запускаете соответствующую службу. И он должен работать для всех языков сценариев (Python, Perl, node.js), а также для пакетных сценариев, таких как GitBash, PowerShell, даже старых сценариев летучей мыши DOS. pyGlue — это связующее звено между службами Windows и вашим скриптом.

Теперь нужно немного отредактировать, и вы не хотите, чтобы все ваши сервисы назывались pyGlue. Итак, есть сценарий (build.sh) для вставки битов и создания настраиваемого «pyGlue» и создания «.exe». Это файл .exe, который устанавливается как служба Windows. После установки вы можете настроить его на автоматический запуск.

Установка — скопируйте ‘.exe’ сервер и скрипт в указанную папку. Запустите .exe от имени администратора с опцией «установить». Откройте службы Windows в качестве администратора и запустите службу. Для обновления просто скопируйте новую версию скрипта и остановите / запустите службу.

Теперь все серверы разные — разные установки Python, разные структуры папок. Я поддерживаю папку для каждого сервера с копией pyGlue.py и build.sh. И я создаю сценарий serverBuild.sh для восстановления всей службы на этом сервере.

Следите за PySvc.py

изменение папки dll

Я знаю, что это старое, но я застрял на этом навсегда. Для меня эта конкретная проблема была решена путем копирования этого файла — pywintypes36.dll

Из -> Python36 \ Lib \ site-packages \ pywin32_system32

Кому -> Python36 \ Lib \ site-packages \ win32

1. изменение пути к папке python на

1. NET START PySvc
2. NET STOP PySvc