{"id":4304,"date":"2020-11-04T01:47:39","date_gmt":"2020-11-03T20:17:39","guid":{"rendered":"https:\/\/golangbyexamples.com\/?p=4304"},"modified":"2020-11-04T01:47:50","modified_gmt":"2020-11-03T20:17:50","slug":"module-import-path-golang","status":"publish","type":"post","link":"https:\/\/golangbyexamples.com\/module-import-path-golang\/","title":{"rendered":"Understanding Module name or module import path in Go (Golang)"},"content":{"rendered":"\n<div id=\"ez-toc-container\" class=\"ez-toc-v2_0_17 counter-hierarchy counter-decimal ez-toc-light-blue\">\n<div class=\"ez-toc-title-container\">\n<p class=\"ez-toc-title\">Table of Contents<\/p>\n<span class=\"ez-toc-title-toggle\"><a class=\"ez-toc-pull-right ez-toc-btn ez-toc-btn-xs ez-toc-btn-default ez-toc-toggle\" style=\"display: none;\"><i class=\"ez-toc-glyphicon ez-toc-icon-toggle\"><\/i><\/a><\/span><\/div>\n<nav><ul class=\"ez-toc-list ez-toc-list-level-1\"><li class=\"ez-toc-page-1 ez-toc-heading-level-1\"><a class=\"ez-toc-link ez-toc-heading-1\" href=\"https:\/\/golangbyexamples.com\/module-import-path-golang\/#Overview\" title=\"Overview\">Overview<\/a><\/li><li class=\"ez-toc-page-1 ez-toc-heading-level-1\"><a class=\"ez-toc-link ez-toc-heading-2\" href=\"https:\/\/golangbyexamples.com\/module-import-path-golang\/#The_module_is_a_utility_module_and_you_plan_to_publish_your_module_to_VCS_like_git\" title=\"The module is a utility module and you plan to publish your module to VCS like git\">The module is a utility module and you plan to publish your module to VCS like git<\/a><\/li><li class=\"ez-toc-page-1 ez-toc-heading-level-1\"><a class=\"ez-toc-link ez-toc-heading-3\" href=\"https:\/\/golangbyexamples.com\/module-import-path-golang\/#The_module_is_a_utility_module_and_you_dont_plan_to_publish_your_module\" title=\"The module is a utility module and you don&#8217;t plan to publish your module\">The module is a utility module and you don&#8217;t plan to publish your module<\/a><\/li><li class=\"ez-toc-page-1 ez-toc-heading-level-1\"><a class=\"ez-toc-link ez-toc-heading-4\" href=\"https:\/\/golangbyexamples.com\/module-import-path-golang\/#The_module_is_a_executable_module\" title=\"The module is a executable module\">The module is a executable module<\/a><\/li><\/ul><\/nav><\/div>\n<h1 class=\"wp-block-heading\"><span class=\"ez-toc-section\" id=\"Overview\"><\/span><strong>Overview<\/strong><span class=\"ez-toc-section-end\"><\/span><\/h1>\n\n\n\n<p class=\"has-medium-font-size\">Module is go support for dependency management. A module by definition is a collection of related packages with <strong>go.mod<\/strong> at its root.&nbsp; The <strong>go.mod<\/strong> file defines the<\/p>\n\n\n\n<ul class=\"has-medium-font-size wp-block-list\"><li>Module import path.<\/li><\/ul>\n\n\n\n<ul class=\"has-medium-font-size wp-block-list\"><li>Dependency requirements of the module for a successful build. It defines both project&#8217;s dependencies requirement and also locks them to their correct version.<\/li><\/ul>\n\n\n\n<p class=\"has-medium-font-size\">Now let&#8217;s discuss more in detail about the module import path. It is the prefix path that is used to import all packages of that module. Let&#8217;s see an example to better understand the module import path. For that let&#8217;s create a module<\/p>\n\n\n\n<pre class=\"wp-block-prismatic-blocks\"><code class=\"language-go\">go mod init sample.com\/learn<\/code><\/pre>\n\n\n\n<p class=\"has-medium-font-size\">Above command will create a module with import path as <a href=\"http:\/\/sample.com\">sample.com<\/a>\/learn. It will also create a <strong>go.mod<\/strong> file in the same directory. Let&#8217;s examine the contents of this file. Do a cat<strong> go.mod<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-prismatic-blocks\"><code class=\"language-go\">module sample.com\/learn\n\ngo 1.14<\/code><\/pre>\n\n\n\n<p class=\"has-medium-font-size\">The first line of the go.mod file will have the module import path as you can see in the <strong>go.mod<\/strong> file above as well. Now where is this module import path useful. The import path of a module is used to import any package of that module from any other module. This any other module will use module import path as prefix path plus the folder path of the package.<\/p>\n\n\n\n<pre class=\"wp-block-prismatic-blocks\"><code class=\"language-go\">module_import_path + folder_path_of_package<\/code><\/pre>\n\n\n\n<p class=\"has-medium-font-size\">So if the <strong>sample.com\/learn<\/strong> module contains a <strong>math<\/strong> package present at directory <strong>math<\/strong>, then any other module can import the <strong>math<\/strong> package using the path<\/p>\n\n\n\n<pre class=\"wp-block-prismatic-blocks\"><code class=\"language-go\">sample.com\/learn\/math<\/code><\/pre>\n\n\n\n<p class=\"has-medium-font-size\">Now let&#8217;s see what factors decide the naming of the module import path. There can be three cases that decide what import pathname can be used with modules.<\/p>\n\n\n\n<ul class=\"has-medium-font-size wp-block-list\"><li>The module is a utility module and you plan to publish your module<\/li><\/ul>\n\n\n\n<ul class=\"has-medium-font-size wp-block-list\"><li>The module is a utility module and you don&#8217;t plan to publish your module<\/li><\/ul>\n\n\n\n<ul class=\"has-medium-font-size wp-block-list\"><li>The module is an executable module<\/li><\/ul>\n\n\n\n<h1 class=\"wp-block-heading\"><span class=\"ez-toc-section\" id=\"The_module_is_a_utility_module_and_you_plan_to_publish_your_module_to_VCS_like_git\"><\/span><strong>The module is a utility module and you plan to publish your module to VCS like git<\/strong><span class=\"ez-toc-section-end\"><\/span><\/h1>\n\n\n\n<p class=\"has-medium-font-size\">If you plan to publish your module then the module name should match the URL of the repo that host that module. Go tries to download dependencies from the VCS using the import path of the module.<\/p>\n\n\n\n<p class=\"has-medium-font-size\">For example, notice the module import path of this module <a href=\"https:\/\/github.com\/pborman\/uuid\">https:\/\/github.com\/pborman\/uuid<\/a> . The go.mod file is as below<\/p>\n\n\n\n<pre class=\"wp-block-prismatic-blocks\"><code class=\"language-go\">module github.com\/pborman\/uuid\n\n...<\/code><\/pre>\n\n\n\n<p class=\"has-medium-font-size\">Notice that the URL of the module is same as module import path.<\/p>\n\n\n\n<h1 class=\"wp-block-heading\"><span class=\"ez-toc-section\" id=\"The_module_is_a_utility_module_and_you_dont_plan_to_publish_your_module\"><\/span><strong>The module is a utility module and you don&#8217;t plan to publish your module<\/strong><span class=\"ez-toc-section-end\"><\/span><\/h1>\n\n\n\n<p class=\"has-medium-font-size\">This is the case when you only mean to use the utility module locally only. In this case, the import path can be anything. Refer to this example where we illustrated how we can import a local module. In the example, we have used a name for the module import path which doesn&#8217;t represent the VCS repository.<\/p>\n\n\n\n<p class=\"has-medium-font-size\"><a href=\"https:\/\/golangbyexamples.com\/import-local-module-golang\">https:\/\/golangbyexamples.com\/import-local-module-golang<\/a>\/<\/p>\n\n\n\n<h1 class=\"wp-block-heading\"><span class=\"ez-toc-section\" id=\"The_module_is_a_executable_module\"><\/span><strong>The module is a executable module<\/strong><span class=\"ez-toc-section-end\"><\/span><\/h1>\n\n\n\n<p class=\"has-medium-font-size\">In this case, also the module import path can be anything. The module import path can be a non-URL even if you plan to commit your module into VCS as it will not be used by any other module.<\/p>\n\n\n\n<p class=\"has-medium-font-size\">However, it is a good practice to use a meaningful import path while creating a module<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Table of Contents OverviewThe module is a utility module and you plan to publish your module to VCS like gitThe module is a utility module and you don&#8217;t plan to publish your&#8230;<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"spay_email":"","footnotes":"","jetpack_publicize_message":"","jetpack_is_tweetstorm":false},"categories":[1],"tags":[3,4],"class_list":["post-4304","post","type-post","status-publish","format-standard","hentry","category-tech","tag-go","tag-golang"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v22.7 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Understanding Module name or module import path in Go (Golang) - Welcome To Golang By Example<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/golangbyexamples.com\/module-import-path-golang\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Understanding Module name or module import path in Go (Golang) - Welcome To Golang By Example\" \/>\n<meta property=\"og:description\" content=\"Table of Contents OverviewThe module is a utility module and you plan to publish your module to VCS like gitThe module is a utility module and you don&#8217;t plan to publish your...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/golangbyexamples.com\/module-import-path-golang\/\" \/>\n<meta property=\"og:site_name\" content=\"Welcome To Golang By Example\" \/>\n<meta property=\"article:published_time\" content=\"2020-11-03T20:17:39+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2020-11-03T20:17:50+00:00\" \/>\n<meta name=\"author\" content=\"admin\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"admin\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/golangbyexamples.com\/module-import-path-golang\/\",\"url\":\"https:\/\/golangbyexamples.com\/module-import-path-golang\/\",\"name\":\"Understanding Module name or module import path in Go (Golang) - Welcome To Golang By Example\",\"isPartOf\":{\"@id\":\"https:\/\/golangbyexamples.com\/#website\"},\"datePublished\":\"2020-11-03T20:17:39+00:00\",\"dateModified\":\"2020-11-03T20:17:50+00:00\",\"author\":{\"@id\":\"https:\/\/golangbyexamples.com\/#\/schema\/person\/8833ea7638dafd763cb1db6c0ca4576f\"},\"breadcrumb\":{\"@id\":\"https:\/\/golangbyexamples.com\/module-import-path-golang\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/golangbyexamples.com\/module-import-path-golang\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/golangbyexamples.com\/module-import-path-golang\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/golangbyexamples.com\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Understanding Module name or module import path in Go (Golang)\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/golangbyexamples.com\/#website\",\"url\":\"https:\/\/golangbyexamples.com\/\",\"name\":\"Welcome To Golang By Example\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/golangbyexamples.com\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\/\/golangbyexamples.com\/#\/schema\/person\/8833ea7638dafd763cb1db6c0ca4576f\",\"name\":\"admin\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/golangbyexamples.com\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/?s=96&d=mm&r=g\",\"caption\":\"admin\"},\"url\":\"https:\/\/golangbyexamples.com\/author\/admin\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Understanding Module name or module import path in Go (Golang) - Welcome To Golang By Example","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/golangbyexamples.com\/module-import-path-golang\/","og_locale":"en_US","og_type":"article","og_title":"Understanding Module name or module import path in Go (Golang) - Welcome To Golang By Example","og_description":"Table of Contents OverviewThe module is a utility module and you plan to publish your module to VCS like gitThe module is a utility module and you don&#8217;t plan to publish your...","og_url":"https:\/\/golangbyexamples.com\/module-import-path-golang\/","og_site_name":"Welcome To Golang By Example","article_published_time":"2020-11-03T20:17:39+00:00","article_modified_time":"2020-11-03T20:17:50+00:00","author":"admin","twitter_card":"summary_large_image","twitter_misc":{"Written by":"admin","Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/golangbyexamples.com\/module-import-path-golang\/","url":"https:\/\/golangbyexamples.com\/module-import-path-golang\/","name":"Understanding Module name or module import path in Go (Golang) - Welcome To Golang By Example","isPartOf":{"@id":"https:\/\/golangbyexamples.com\/#website"},"datePublished":"2020-11-03T20:17:39+00:00","dateModified":"2020-11-03T20:17:50+00:00","author":{"@id":"https:\/\/golangbyexamples.com\/#\/schema\/person\/8833ea7638dafd763cb1db6c0ca4576f"},"breadcrumb":{"@id":"https:\/\/golangbyexamples.com\/module-import-path-golang\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/golangbyexamples.com\/module-import-path-golang\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/golangbyexamples.com\/module-import-path-golang\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/golangbyexamples.com\/"},{"@type":"ListItem","position":2,"name":"Understanding Module name or module import path in Go (Golang)"}]},{"@type":"WebSite","@id":"https:\/\/golangbyexamples.com\/#website","url":"https:\/\/golangbyexamples.com\/","name":"Welcome To Golang By Example","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/golangbyexamples.com\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/golangbyexamples.com\/#\/schema\/person\/8833ea7638dafd763cb1db6c0ca4576f","name":"admin","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/golangbyexamples.com\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/?s=96&d=mm&r=g","caption":"admin"},"url":"https:\/\/golangbyexamples.com\/author\/admin\/"}]}},"jetpack_featured_media_url":"","jetpack_publicize_connections":[],"jetpack_sharing_enabled":true,"jetpack_shortlink":"https:\/\/wp.me\/paOs1b-17q","amp_validity":null,"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/golangbyexamples.com\/wp-json\/wp\/v2\/posts\/4304","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/golangbyexamples.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/golangbyexamples.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/golangbyexamples.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/golangbyexamples.com\/wp-json\/wp\/v2\/comments?post=4304"}],"version-history":[{"count":1,"href":"https:\/\/golangbyexamples.com\/wp-json\/wp\/v2\/posts\/4304\/revisions"}],"predecessor-version":[{"id":4305,"href":"https:\/\/golangbyexamples.com\/wp-json\/wp\/v2\/posts\/4304\/revisions\/4305"}],"wp:attachment":[{"href":"https:\/\/golangbyexamples.com\/wp-json\/wp\/v2\/media?parent=4304"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/golangbyexamples.com\/wp-json\/wp\/v2\/categories?post=4304"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/golangbyexamples.com\/wp-json\/wp\/v2\/tags?post=4304"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}